diff --git a/services/console/src/chunks/docs-how-to/github-actions/base-branch-code.mdx b/services/console/src/chunks/docs-how-to/github-actions/base-branch-code.mdx index c87124d18..40c7494b1 100644 --- a/services/console/src/chunks/docs-how-to/github-actions/base-branch-code.mdx +++ b/services/console/src/chunks/docs-how-to/github-actions/base-branch-code.mdx @@ -6,6 +6,8 @@ on: jobs: benchmark_base_branch: name: Continuous Benchmarking with Bencher + permissions: + checks: write runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 diff --git a/services/console/src/chunks/docs-how-to/github-actions/de/base-branch.mdx b/services/console/src/chunks/docs-how-to/github-actions/de/base-branch.mdx index 7151a0277..1d38cb8b0 100644 --- a/services/console/src/chunks/docs-how-to/github-actions/de/base-branch.mdx +++ b/services/console/src/chunks/docs-how-to/github-actions/de/base-branch.mdx @@ -16,32 +16,35 @@ Diese historische Basislinie kann dann verwendet werden, um Leistungsregressione (z.B.: `on: push: branches: main`) 3. Erstellen Sie einen `job` für GitHub Actions. (z.B.: `jobs: benchmark_base_branch`) -4. Legen Sie den Maschinentyp fest, auf dem der Job ausgeführt wird. +4. Setzen Sie [die Berechtigungen für das `GITHUB_TOKEN`][github token permissions] + auf `write` für `checks`. + (z.B.: `permissions: checks: write`) +5. Legen Sie den Maschinentyp fest, auf dem der Job ausgeführt wird. Siehe die [GitHub Actions `runs-on` Dokumentation][github actions runs-on] für einen vollständigen Überblick. (z.B.: `runs-on: ubuntu-latest`) -5. Checken Sie Ihren Basis-Branch Quellcode aus. +6. Checken Sie Ihren Basis-Branch Quellcode aus. (z.B.: `uses: actions/checkout@v4`) -6. Installieren Sie die Bencher CLI mithilfe der [GitHub Action][bencher cli github action]. +7. Installieren Sie die Bencher CLI mithilfe der [GitHub Action][bencher cli github action]. (z.B.: `uses: bencherdev/bencher@main`) -7. Verwenden Sie das bencher run CLI-Unterkommando, +8. Verwenden Sie das bencher run CLI-Unterkommando, um Ihre `main`-Branch Benchmarks auszuführen. Siehe [das `bencher run` CLI-Unterkommando][bencher run] für einen vollständigen Überblick. (z.B.: `bencher run`) -8. Setzen Sie die `--project` Option auf den Project-Slug. +9. Setzen Sie die `--project` Option auf den Project-Slug. Siehe [die `--project` Doku][project option] für weitere Details. (z.B.: `--project save-walter-white-1234abcd`) -9. Setzen Sie die `--token` Option auf das **Repository**-Geheimnis `BENCHER_API_TOKEN`. +10. Setzen Sie die `--token` Option auf das **Repository**-Geheimnis `BENCHER_API_TOKEN`. Siehe [die `--token` Doku][token option] für weitere Details. (z.B.: `--token '${{ secrets.BENCHER_API_TOKEN }}'`) -10. Setzen Sie die `--branch` Option auf den Basis-Branch Namen. +11. Setzen Sie die `--branch` Option auf den Basis-Branch Namen. Siehe [die `--branch` Doku][branch option] für einen vollständigen Überblick. (z.B.: `--branch main`) -11. Setzen Sie die `--testbed` Option auf den Testbed-Namen. +12. Setzen Sie die `--testbed` Option auf den Testbed-Namen. Dies sollte wahrscheinlich mit der in `runs-on` ausgewählten Maschine übereinstimmen. Siehe [die `--testbed` Doku][testbed option] für weitere Details. (z.B.: `--testbed ubuntu-latest`) -12. Setzen Sie den Threshold für den `main` Branch, `ubuntu-latest` Testbed und das `latency` Maß: +13. Setzen Sie den Threshold für den `main` Branch, `ubuntu-latest` Testbed und das `latency` Maß: 1. Setzen Sie die `--threshold-measure` Option auf das eingebaute `latency` Measure, das von bencher mock generiert wird. Siehe [die `--threshold-measure` Doku][threshold measure option] für weitere Details. (z.B.: `--threshold-measure latency`) @@ -57,25 +60,26 @@ Diese historische Basislinie kann dann verwendet werden, um Leistungsregressione 5. Setzen Sie die `--thresholds-reset` Flag, damit nur der angegebene Threshold aktiv ist. Siehe [die `--thresholds-reset` Doku][thresholds reset] für einen vollständigen Überblick. (z.B.: `--thresholds-reset`) -13. Setzen Sie die `--err` Flag, damit der Befehl fehlschlägt, wenn ein Alert generiert wird. +14. Setzen Sie die `--err` Flag, damit der Befehl fehlschlägt, wenn ein Alert generiert wird. Siehe [die `--err` Doku][alert err] für einen vollständigen Überblick. (z.B.: `--err`) -14. Setzen Sie die `--adapter` Option auf das [Bencher Metric Format JSON (`json`)][bmf], das von bencher mock generiert wird. +15. Setzen Sie die `--adapter` Option auf das [Bencher Metric Format JSON (`json`)][bmf], das von bencher mock generiert wird. Siehe [benchmark harness adapters][adapter json] für einen vollständigen Überblick. (z.B.: `--adapter json`) -15. Setzen Sie die `--github-actions` Option auf das GitHub API-Authentifizierungstoken, um Ergebnisse als GitHub Checks Kommentar zu posten, mithilfe +16. Setzen Sie die `--github-actions` Option auf das GitHub API-Authentifizierungstoken, um Ergebnisse als GitHub Checks Kommentar zu posten, mithilfe der [GitHub Actions `GITHUB_TOKEN` Umgebungsvariable][github token]. Siehe [die `--github-actions` Doku][github actions option] für weitere Details. (z.B.: `--github-actions '${{ secrets.GITHUB_TOKEN }}'`) -16. Geben Sie die Argumente des Benchmark-Befehls an. +17. Geben Sie die Argumente des Benchmark-Befehls an. Siehe [benchmark command][command argument] für einen vollständigen Überblick. (z.B.: `bencher mock`) -[github actions on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on -[github actions push]: https://docs.github.com/en/webhooks/webhook-events-and-payloads#push -[github actions runs-on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on +[github actions on]: https://docs.github.com/de/actions/using-workflows/workflow-syntax-for-github-actions#on +[github actions push]: https://docs.github.com/de/webhooks/webhook-events-and-payloads#push +[github token permissions]: https://docs.github.com/de/actions/using-jobs/assigning-permissions-to-jobs#setting-the-github_token-permissions-for-a-specific-job +[github actions runs-on]: https://docs.github.com/de/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on [bencher cli github action]: https://github.com/marketplace/actions/bencher-cli -[github token]: https://docs.github.com/en/actions/security-guides/automatic-token-authentication +[github token]: https://docs.github.com/de/actions/security-guides/automatic-token-authentication [statistical continuous benchmarking]: /de/docs/how-to/track-benchmarks/#statistical-continuous-benchmarking [bencher run]: /de/docs/explanation/bencher-run/ diff --git a/services/console/src/chunks/docs-how-to/github-actions/de/pull-requests-closed.mdx b/services/console/src/chunks/docs-how-to/github-actions/de/pull-requests-closed.mdx index 30abcc434..689755560 100644 --- a/services/console/src/chunks/docs-how-to/github-actions/de/pull-requests-closed.mdx +++ b/services/console/src/chunks/docs-how-to/github-actions/de/pull-requests-closed.mdx @@ -20,41 +20,29 @@ Dieser Workflow archiviert den PR-Branch mit dem Befehl `bencher archive`. ⚠️ ENTFERNEN SIE NICHT DIESE ZEILE! Weitere Informationen zum Umgang mit Fork-PRs finden Sie weiter unten unter [Pull Requests von Forks][pull requests from forks]. (z.B.: `if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository`) -5. Setzen Sie [die Berechtigungen für das `GITHUB_TOKEN`][github token permissions] - auf `write` für `pull-requests`. - Abhängig von Ihren GitHub-Einstellungen ist dies möglicherweise nicht erforderlich. - Doch bei allen Organisationen und persönlichen Repositories, - [die nach dem 02. Feb 2023 erstellt wurden][github token read only], - ist dies das Standardverhalten. - Lesen Sie [die GitHub-Dokumentation][github token permissions security] - für einen vollständigen Überblick. - (z.B.: `permissions: pull-requests: write`) -6. Legen Sie den Maschinentyp fest, auf dem der Job ausgeführt werden soll. +5. Legen Sie den Maschinentyp fest, auf dem der Job ausgeführt werden soll. Lesen Sie die [GitHub Actions `runs-on` Dokumentation][github actions runs-on] für einen vollständigen Überblick. (z.B.: `runs-on: ubuntu-latest`) -7. Checken Sie den Quellcode des PR-Branches aus. +6. Checken Sie den Quellcode des PR-Branches aus. (z.B.: `uses: actions/checkout@v4`) -8. Installieren Sie die Bencher CLI über [die GitHub Action][bencher cli github action]. +7. Installieren Sie die Bencher CLI über [die GitHub Action][bencher cli github action]. (z.B.: `uses: bencherdev/bencher@main`) -9. Verwenden Sie den `bencher archive` CLI-Unterbefehl, um den PR-Branch zu archivieren. +8. Verwenden Sie den `bencher archive` CLI-Unterbefehl, um den PR-Branch zu archivieren. (z.B.: `bencher archive`) -10. Setzen Sie die `--project` Option auf das Projektslug. +9. Setzen Sie die `--project` Option auf das Projektslug. Siehe [die `--project` Dokumentation][project option] für mehr Details. (z.B.: `--project save-walter-white-1234abcd`) -11. Setzen Sie die `--token` Option auf das **Repository**-Geheimnis `BENCHER_API_TOKEN`. +10. Setzen Sie die `--token` Option auf das **Repository**-Geheimnis `BENCHER_API_TOKEN`. Siehe [die `--token` Dokumentation][token option] für mehr Details. (z.B.: `--token '${{ secrets.BENCHER_API_TOKEN }}'`) -12. Setzen Sie die `--branch` Option auf den Namen des PR-Branches +11. Setzen Sie die `--branch` Option auf den Namen des PR-Branches mit dem [GitHub Actions `github` Kontext][github actions context]. (z.B.: `--branch '${{ github.head_ref }}'`) [github actions on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on [github action pull_request]: https://docs.github.com/en/webhooks/webhook-events-and-payloads#pull_request -[github token permissions]: https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs#setting-the-github_token-permissions-for-a-specific-job -[github token read only]: https://github.blog/changelog/2023-02-02-github-actions-updating-the-default-github_token-permissions-to-read-only/ -[github token permissions security]: https://docs.github.com/en/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token [github actions runs-on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on [bencher cli github action]: https://github.com/marketplace/actions/bencher-cli [github actions context]: https://docs.github.com/en/actions/learn-github-actions/contexts#github-context diff --git a/services/console/src/chunks/docs-how-to/github-actions/de/pull-requests-fork-closed.mdx b/services/console/src/chunks/docs-how-to/github-actions/de/pull-requests-fork-closed.mdx index 746469149..c139210ca 100644 --- a/services/console/src/chunks/docs-how-to/github-actions/de/pull-requests-fork-closed.mdx +++ b/services/console/src/chunks/docs-how-to/github-actions/de/pull-requests-fork-closed.mdx @@ -16,40 +16,28 @@ Dieser Workflow archiviert den Fork-PR-Branch mit dem Befehl `bencher archive`. (z.B.: `on: pull_request: types: [closed]`) 3. Erstellen Sie einen GitHub Actions `job`. (z.B.: `jobs: archive_pr_branch`) -4. Setzen Sie [die Berechtigungen für das `GITHUB_TOKEN`][github token permissions] - auf `write` für `pull-requests`. - Abhängig von Ihren GitHub-Einstellungen ist dies möglicherweise nicht erforderlich. - Aber für alle Organisationen und persönlichen Repos - [erstellt nach dem 02. Februar 2023][github token read only], - ist dies das Standardverhalten. - Siehe [die GitHub-Dokumentation][github token permissions security] - für einen vollständigen Überblick. - (z.B.: `permissions: pull-requests: write`) -5. Legen Sie die Art der Maschine fest, auf der der Job ausgeführt wird. +4. Legen Sie die Art der Maschine fest, auf der der Job ausgeführt wird. Siehe die [GitHub Actions `runs-on` Dokumentation][github actions runs-on] für einen vollständigen Überblick. (z.B.: `runs-on: ubuntu-latest`) -6. Überprüfen Sie den PR-Branch-Quellcode. +5. Überprüfen Sie den PR-Branch-Quellcode. (z.B.: `uses: actions/checkout@v4`) -7. Installieren Sie das Bencher CLI mithilfe [der GitHub Action][bencher cli github action]. +6. Installieren Sie das Bencher CLI mithilfe [der GitHub Action][bencher cli github action]. (z.B.: `uses: bencherdev/bencher@main`) -8. Verwenden Sie das CLI-Unterkommando `bencher archive`, um den PR-Branch zu archivieren. +7. Verwenden Sie das CLI-Unterkommando `bencher archive`, um den PR-Branch zu archivieren. (z.B.: `bencher archive`) -9. Setzen Sie die `--project`-Option auf das Projekt-Slug. +8. Setzen Sie die `--project`-Option auf das Projekt-Slug. Siehe die [Dokumentation zur `--project` Option][project option] für weitere Details. (z.B.: `--project save-walter-white-1234abcd`) -10. Setzen Sie die `--token`-Option auf das **Repository**-Geheimnis `BENCHER_API_TOKEN`. +9. Setzen Sie die `--token`-Option auf das **Repository**-Geheimnis `BENCHER_API_TOKEN`. Siehe die [Dokumentation zur `--token` Option][token option] für weitere Details. (z.B.: `--token '${{ secrets.BENCHER_API_TOKEN }}'`) -11. Setzen Sie die `--branch`-Option auf den Namen des PR-Branchs +10. Setzen Sie die `--branch`-Option auf den Namen des PR-Branchs mithilfe [des GitHub Actions `github` Kontexts][github actions context]. (z.B.: `--branch '${{ github.head_ref }}'`) [github actions on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on [github action pull_request]: https://docs.github.com/en/webhooks/webhook-events-and-payloads#pull_request -[github token permissions]: https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs#setting-the-github_token-permissions-for-a-specific-job -[github token read only]: https://github.blog/changelog/2023-02-02-github-actions-updating-the-default-github_token-permissions-to-read-only/ -[github token permissions security]: https://docs.github.com/en/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token [github actions runs-on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on [bencher cli github action]: https://github.com/marketplace/actions/bencher-cli [github actions context]: https://docs.github.com/en/actions/learn-github-actions/contexts#github-context diff --git a/services/console/src/chunks/docs-how-to/github-actions/en/base-branch.mdx b/services/console/src/chunks/docs-how-to/github-actions/en/base-branch.mdx index e118e7b6e..9d4752458 100644 --- a/services/console/src/chunks/docs-how-to/github-actions/en/base-branch.mdx +++ b/services/console/src/chunks/docs-how-to/github-actions/en/base-branch.mdx @@ -16,32 +16,35 @@ This historical baseline can then be used to detect performance regressions in P (ex: `on: push: branches: main`) 3. Create a GitHub Actions `job`. (ex: `jobs: benchmark_base_branch`) -4. Set the type of machine the job will run on. +4. Set [the permissions for the `GITHUB_TOKEN`][github token permissions] + to `write` for `checks`. + (ex: `permissions: checks: write`) +5. Set the type of machine the job will run on. See the [GitHub Actions `runs-on` documentation][github actions runs-on] for a full overview. (ex: `runs-on: ubuntu-latest`) -5. Checkout your base branch source code. +6. Checkout your base branch source code. (ex: `uses: actions/checkout@v4`) -6. Install the Bencher CLI using [the GitHub Action][bencher cli github action]. +7. Install the Bencher CLI using [the GitHub Action][bencher cli github action]. (ex: `uses: bencherdev/bencher@main`) -7. Use the bencher run CLI subcommand +8. Use the bencher run CLI subcommand to run your `main` branch benchmarks. See [the `bencher run` CLI subcommand][bencher run] for a full overview. (ex: `bencher run`) -8. Set the `--project` option to the Project slug. +9. Set the `--project` option to the Project slug. See [the `--project` docs][project option] for more details. (ex: `--project save-walter-white-1234abcd`) -9. Set the `--token` option to the `BENCHER_API_TOKEN` **Repository** secret. +10. Set the `--token` option to the `BENCHER_API_TOKEN` **Repository** secret. See [the `--token` docs][token option] for more details. (ex: `--token '${{ secrets.BENCHER_API_TOKEN }}'`) -10. Set the `--branch` option to the base Branch name. +11. Set the `--branch` option to the base Branch name. See [the `--branch` docs][branch option] for a full overview. (ex: `--branch main`) -11. Set the `--testbed` option to the Testbed name. +12. Set the `--testbed` option to the Testbed name. This should likely match the machine selected in `runs-on`. See [the `--tested` docs][testbed option] for more details. (ex: `--testbed ubuntu-latest`) -12. Set the Threshold for the `main` Branch, `ubuntu-latest` Testbed, and `latency` Measure: +13. Set the Threshold for the `main` Branch, `ubuntu-latest` Testbed, and `latency` Measure: 1. Set the `--threshold-measure` option to the built-in `latency` Measure that is generated by bencher mock. See [the `--threshold-measure` docs][threshold measure option] for more details. (ex: `--threshold-measure latency`) @@ -57,22 +60,23 @@ This historical baseline can then be used to detect performance regressions in P 5. Set the `--thresholds-reset` flag so that only the specified Threshold is active. See [the `--thresholds-reset` docs][thresholds reset] for a full overview. (ex: `--thresholds-reset`) -13. Set the `--err` flag to fail the command if an Alert is generated. +14. Set the `--err` flag to fail the command if an Alert is generated. See [the `--err` docs][alert err] for a full overview. (ex: `--err`) -14. Set the `--adapter` option to [Bencher Metric Format JSON (`json`)][bmf] that is generated by bencher mock. +15. Set the `--adapter` option to [Bencher Metric Format JSON (`json`)][bmf] that is generated by bencher mock. See [benchmark harness adapters][adapter json] for a full overview. (ex: `--adapter json`) -15. Set the `--github-actions` option to the GitHub API authentication token to post results as a GitHub Checks comment using +16. Set the `--github-actions` option to the GitHub API authentication token to post results as a GitHub Checks comment using [the GitHub Actions `GITHUB_TOKEN` environment variable][github token]. See [the `--github-actions` docs][github actions option] for more details. (ex: `--github-actions '${{ secrets.GITHUB_TOKEN }}'`) -16. Specify the benchmark command arguments. +17. Specify the benchmark command arguments. See [benchmark command][command argument] for a full overview. (ex: `bencher mock`) [github actions on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on [github actions push]: https://docs.github.com/en/webhooks/webhook-events-and-payloads#push +[github token permissions]: https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs#setting-the-github_token-permissions-for-a-specific-job [github actions runs-on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on [bencher cli github action]: https://github.com/marketplace/actions/bencher-cli [github token]: https://docs.github.com/en/actions/security-guides/automatic-token-authentication diff --git a/services/console/src/chunks/docs-how-to/github-actions/en/pull-requests-closed.mdx b/services/console/src/chunks/docs-how-to/github-actions/en/pull-requests-closed.mdx index 636a744b7..3689006bb 100644 --- a/services/console/src/chunks/docs-how-to/github-actions/en/pull-requests-closed.mdx +++ b/services/console/src/chunks/docs-how-to/github-actions/en/pull-requests-closed.mdx @@ -20,41 +20,29 @@ This workflow will archive the PR branch using the `bencher archive` command. ⚠️ DO NOT REMOVE THIS LINE! For handling Fork PRs see [Pull Requests from Forks][pull requests from forks] below. (ex: `if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository`) -5. Set [the permissions for the `GITHUB_TOKEN`][github token permissions] - to `write` for `pull-requests`. - Depending on your GitHub settings, this may not be required. - But for all organizations and personal repos - [created after 02 Feb 2023][github token read only], - this is the default behavior. - See [the GitHub documentation][github token permissions security] - for a full overview. - (ex: `permissions: pull-requests: write`) -6. Set the type of machine the job will run on. +5. Set the type of machine the job will run on. See the [GitHub Actions `runs-on` documentation][github actions runs-on] for a full overview. (ex: `runs-on: ubuntu-latest`) -7. Checkout the PR branch source code. +6. Checkout the PR branch source code. (ex: `uses: actions/checkout@v4`) -8. Install the Bencher CLI using [the GitHub Action][bencher cli github action]. +7. Install the Bencher CLI using [the GitHub Action][bencher cli github action]. (ex: `uses: bencherdev/bencher@main`) -9. Use the `bencher archive` CLI subcommand to archive the PR branch. +8. Use the `bencher archive` CLI subcommand to archive the PR branch. (ex: `bencher archive`) -10. Set the `--project` option to the Project slug. +9. Set the `--project` option to the Project slug. See [the `--project` docs][project option] for more details. (ex: `--project save-walter-white-1234abcd`) -11. Set the `--token` option to the `BENCHER_API_TOKEN` **Repository** secret. +10. Set the `--token` option to the `BENCHER_API_TOKEN` **Repository** secret. See [the `--token` docs][token option] for more details. (ex: `--token '${{ secrets.BENCHER_API_TOKEN }}'`) -12. Set the `--branch` option to the PR branch name +11. Set the `--branch` option to the PR branch name using [the GitHub Actions `github` context][github actions context]. (ex: `--branch '${{ github.head_ref }}'`) [github actions on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on [github action pull_request]: https://docs.github.com/en/webhooks/webhook-events-and-payloads#pull_request -[github token permissions]: https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs#setting-the-github_token-permissions-for-a-specific-job -[github token read only]: https://github.blog/changelog/2023-02-02-github-actions-updating-the-default-github_token-permissions-to-read-only/ -[github token permissions security]: https://docs.github.com/en/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token [github actions runs-on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on [bencher cli github action]: https://github.com/marketplace/actions/bencher-cli [github actions context]: https://docs.github.com/en/actions/learn-github-actions/contexts#github-context diff --git a/services/console/src/chunks/docs-how-to/github-actions/en/pull-requests-fork-closed.mdx b/services/console/src/chunks/docs-how-to/github-actions/en/pull-requests-fork-closed.mdx index 741a90312..2f7348e37 100644 --- a/services/console/src/chunks/docs-how-to/github-actions/en/pull-requests-fork-closed.mdx +++ b/services/console/src/chunks/docs-how-to/github-actions/en/pull-requests-fork-closed.mdx @@ -16,40 +16,28 @@ This workflow will archive the fork PR branch using the `bencher archive` comman (ex: `on: pull_request: types: [closed]`) 3. Create a GitHub Actions `job`. (ex: `jobs: archive_pr_branch`) -4. Set [the permissions for the `GITHUB_TOKEN`][github token permissions] - to `write` for `pull-requests`. - Depending on your GitHub settings, this may not be required. - But for all organizations and personal repos - [created after 02 Feb 2023][github token read only], - this is the default behavior. - See [the GitHub documentation][github token permissions security] - for a full overview. - (ex: `permissions: pull-requests: write`) -5. Set the type of machine the job will run on. +4. Set the type of machine the job will run on. See the [GitHub Actions `runs-on` documentation][github actions runs-on] for a full overview. (ex: `runs-on: ubuntu-latest`) -6. Checkout the PR branch source code. +5. Checkout the PR branch source code. (ex: `uses: actions/checkout@v4`) -7. Install the Bencher CLI using [the GitHub Action][bencher cli github action]. +6. Install the Bencher CLI using [the GitHub Action][bencher cli github action]. (ex: `uses: bencherdev/bencher@main`) -8. Use the `bencher archive` CLI subcommand to archive the PR branch. +7. Use the `bencher archive` CLI subcommand to archive the PR branch. (ex: `bencher archive`) -9. Set the `--project` option to the Project slug. +8. Set the `--project` option to the Project slug. See [the `--project` docs][project option] for more details. (ex: `--project save-walter-white-1234abcd`) -10. Set the `--token` option to the `BENCHER_API_TOKEN` **Repository** secret. +9. Set the `--token` option to the `BENCHER_API_TOKEN` **Repository** secret. See [the `--token` docs][token option] for more details. (ex: `--token '${{ secrets.BENCHER_API_TOKEN }}'`) -11. Set the `--branch` option to the PR branch name +10. Set the `--branch` option to the PR branch name using [the GitHub Actions `github` context][github actions context]. (ex: `--branch '${{ github.head_ref }}'`) [github actions on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on [github action pull_request]: https://docs.github.com/en/webhooks/webhook-events-and-payloads#pull_request -[github token permissions]: https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs#setting-the-github_token-permissions-for-a-specific-job -[github token read only]: https://github.blog/changelog/2023-02-02-github-actions-updating-the-default-github_token-permissions-to-read-only/ -[github token permissions security]: https://docs.github.com/en/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token [github actions runs-on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on [bencher cli github action]: https://github.com/marketplace/actions/bencher-cli [github actions context]: https://docs.github.com/en/actions/learn-github-actions/contexts#github-context diff --git a/services/console/src/chunks/docs-how-to/github-actions/es/base-branch.mdx b/services/console/src/chunks/docs-how-to/github-actions/es/base-branch.mdx index 1d9a0bcad..ba17aa2d8 100644 --- a/services/console/src/chunks/docs-how-to/github-actions/es/base-branch.mdx +++ b/services/console/src/chunks/docs-how-to/github-actions/es/base-branch.mdx @@ -11,24 +11,27 @@ Una piedra angular de [Benchmarking Continuo Estadístico][statistical continuou 2. Ejecutar en eventos de `push` a la rama `main`. Consulta la [documentación `on` de GitHub Actions][github actions on] y la [documentación de `push` de GitHub Actions][github actions push] para una visión completa. (ej: `on: push: branches: main`) 3. Crear un `job` de GitHub Actions. (ej: `jobs: benchmark_base_branch`) -4. Establecer el tipo de máquina en la que se ejecutará el job. +4. Establece [los permisos para el `GITHUB_TOKEN`][github token permissions] + a `write` para `checks`. + (ej: `permissions: checks: write`) +5. Establecer el tipo de máquina en la que se ejecutará el job. Consulta la [documentación `runs-on` de GitHub Actions][github actions runs-on] para una visión completa. (ej: `runs-on: ubuntu-latest`) -5. Revisa tu código fuente de la rama base. +6. Revisa tu código fuente de la rama base. (ej: `uses: actions/checkout@v4`) -6. Instala la CLI de Bencher usando [la Acción de GitHub][bencher cli github action]. +7. Instala la CLI de Bencher usando [la Acción de GitHub][bencher cli github action]. (ej: `uses: bencherdev/bencher@main`) -7. Usa el subcomando bencher run de la CLI para ejecutar tus benchmarks de la rama `main`. Consulta [el subcomando `bencher run` de la CLI][bencher run] para una visión completa. +8. Usa el subcomando bencher run de la CLI para ejecutar tus benchmarks de la rama `main`. Consulta [el subcomando `bencher run` de la CLI][bencher run] para una visión completa. (ej: `bencher run`) -8. Establece la opción `--project` al slug del Proyecto. Consulta [la documentación de `--project`][project option] para más detalles. +9. Establece la opción `--project` al slug del Proyecto. Consulta [la documentación de `--project`][project option] para más detalles. (ej: `--project save-walter-white-1234abcd`) -9. Establece la opción `--token` al secreto de **Repositorio** `BENCHER_API_TOKEN`. Consulta [la documentación de `--token`][token option] para más detalles. +10. Establece la opción `--token` al secreto de **Repositorio** `BENCHER_API_TOKEN`. Consulta [la documentación de `--token`][token option] para más detalles. (ej: `--token '${{ secrets.BENCHER_API_TOKEN }}'`) -10. Establece la opción `--branch` al nombre de la Rama base. Consulta [la documentación de `--branch`][branch option] para una visión completa. +11. Establece la opción `--branch` al nombre de la Rama base. Consulta [la documentación de `--branch`][branch option] para una visión completa. (ej: `--branch main`) -11. Establece la opción `--testbed` al nombre del Testbed. Esto debería probablemente coincidir con la máquina seleccionada en `runs-on`. Consulta [la documentación de `--testbed`][testbed option] para más detalles. +12. Establece la opción `--testbed` al nombre del Testbed. Esto debería probablemente coincidir con la máquina seleccionada en `runs-on`. Consulta [la documentación de `--testbed`][testbed option] para más detalles. (ej: `--testbed ubuntu-latest`) -12. Establece el Umbral para la Rama `main`, Testbed `ubuntu-latest` y la Medida `latency`: +13. Establece el Umbral para la Rama `main`, Testbed `ubuntu-latest` y la Medida `latency`: 1. Establece la opción `--threshold-measure` a la Medida incorporada `latency` que genera bencher mock. Consulta [la documentación de `--threshold-measure`][threshold measure option] para más detalles. (ej: `--threshold-measure latency`) 2. Establece la opción `--threshold-test` a una prueba t de Student (`t_test`). Consulta [la documentación de `--threshold-test`][threshold test option] para una visión completa. @@ -39,23 +42,24 @@ Una piedra angular de [Benchmarking Continuo Estadístico][statistical continuou (ej: `--threshold-upper-boundary 0.99`) 5. Establece la bandera `--thresholds-reset` para que solo el Umbral especificado esté activo. Consulta [la documentación de `--thresholds-reset`][thresholds reset] para una visión completa. (ej: `--thresholds-reset`) -13. Establece la bandera `--err` para que el comando falle si se genera una Alerta. Consulta [la documentación de `--err`][alert err] para una visión completa. +14. Establece la bandera `--err` para que el comando falle si se genera una Alerta. Consulta [la documentación de `--err`][alert err] para una visión completa. (ej: `--err`) -14. Establece la opción `--adapter` al Formato JSON de Métricas de Bencher (`json`) que genera bencher mock. Consulta [adaptadores de harness de benchmark][adapter json] para una visión completa. +15. Establece la opción `--adapter` al Formato JSON de Métricas de Bencher (`json`) que genera bencher mock. Consulta [adaptadores de harness de benchmark][adapter json] para una visión completa. (ej: `--adapter json`) -15. Establece la opción `--github-actions` al token de autenticación de la API de GitHub para publicar resultados como un comentario de Checks de GitHub usando +16. Establece la opción `--github-actions` al token de autenticación de la API de GitHub para publicar resultados como un comentario de Checks de GitHub usando [la variable de entorno `GITHUB_TOKEN` de GitHub Actions][github token]. Consulta [la documentación de `--github-actions`][github actions option] para más detalles. (ej: `--github-actions '${{ secrets.GITHUB_TOKEN }}'`) -16. Especifica los argumentos del comando del benchmark. +17. Especifica los argumentos del comando del benchmark. Consulta [comando de benchmark][command argument] para una visión completa. (ej: `bencher mock`) -[github actions on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on -[github actions push]: https://docs.github.com/en/webhooks/webhook-events-and-payloads#push -[github actions runs-on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on +[github actions on]: https://docs.github.com/es/actions/using-workflows/workflow-syntax-for-github-actions#on +[github actions push]: https://docs.github.com/es/webhooks/webhook-events-and-payloads#push +[github token permissions]: https://docs.github.com/es/actions/using-jobs/assigning-permissions-to-jobs#setting-the-github_token-permissions-for-a-specific-job +[github actions runs-on]: https://docs.github.com/es/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on [bencher cli github action]: https://github.com/marketplace/actions/bencher-cli -[github token]: https://docs.github.com/en/actions/security-guides/automatic-token-authentication +[github token]: https://docs.github.com/es/actions/security-guides/automatic-token-authentication [statistical continuous benchmarking]: /es/docs/how-to/track-benchmarks/#statistical-continuous-benchmarking [bencher run]: /es/docs/explanation/bencher-run/ diff --git a/services/console/src/chunks/docs-how-to/github-actions/es/pull-requests-closed.mdx b/services/console/src/chunks/docs-how-to/github-actions/es/pull-requests-closed.mdx index 4c060fb0e..1100a9407 100644 --- a/services/console/src/chunks/docs-how-to/github-actions/es/pull-requests-closed.mdx +++ b/services/console/src/chunks/docs-how-to/github-actions/es/pull-requests-closed.mdx @@ -20,41 +20,29 @@ Este flujo de trabajo archivará la rama del PR usando el comando `bencher archi ⚠️ ¡NO ELIMINE ESTA LÍNEA! Para manejar PRs de forks, consulte [Pull Requests de Forks][pull requests from forks] más abajo. (ej: `if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository`) -5. Configure [los permisos para el `GITHUB_TOKEN`][github token permissions] - a `write` para `pull-requests`. - Dependiendo de su configuración de GitHub, esto puede no ser necesario. - Pero para todas las organizaciones y repositorios personales - [creados después del 02 de febrero de 2023][github token read only], - este es el comportamiento predeterminado. - Consulte [la documentación de GitHub][github token permissions security] - para una visión completa. - (ej: `permissions: pull-requests: write`) -6. Configure el tipo de máquina en la cual el job se ejecutará. +5. Configure el tipo de máquina en la cual el job se ejecutará. Consulte la [documentación de `runs-on` de GitHub Actions][github actions runs-on] para una visión completa. (ej: `runs-on: ubuntu-latest`) -7. Realice el checkout del código fuente de la rama del PR. +6. Realice el checkout del código fuente de la rama del PR. (ej: `uses: actions/checkout@v4`) -8. Instale el CLI de Bencher usando [el GitHub Action][bencher cli github action]. +7. Instale el CLI de Bencher usando [el GitHub Action][bencher cli github action]. (ej: `uses: bencherdev/bencher@main`) -9. Use el subcomando CLI `bencher archive` para archivar la rama del PR. +8. Use el subcomando CLI `bencher archive` para archivar la rama del PR. (ej: `bencher archive`) -10. Configure la opción `--project` al slug del proyecto. +9. Configure la opción `--project` al slug del proyecto. Consulte [los documentos de `--project`][project option] para más detalles. (ej: `--project save-walter-white-1234abcd`) -11. Configure la opción `--token` al secreto **Repository** `BENCHER_API_TOKEN`. +10. Configure la opción `--token` al secreto **Repository** `BENCHER_API_TOKEN`. Consulte [los documentos de `--token`][token option] para más detalles. (ej: `--token '${{ secrets.BENCHER_API_TOKEN }}'`) -12. Configure la opción `--branch` al nombre de la rama del PR +11. Configure la opción `--branch` al nombre de la rama del PR utilizando [el contexto `github` de GitHub Actions][github actions context]. (ej: `--branch '${{ github.head_ref }}'`) [github actions on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on [github action pull_request]: https://docs.github.com/en/webhooks/webhook-events-and-payloads#pull_request -[github token permissions]: https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs#setting-the-github_token-permissions-for-a-specific-job -[github token read only]: https://github.blog/changelog/2023-02-02-github-actions-updating-the-default-github_token-permissions-to-read-only/ -[github token permissions security]: https://docs.github.com/en/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token [github actions runs-on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on [bencher cli github action]: https://github.com/marketplace/actions/bencher-cli [github actions context]: https://docs.github.com/en/actions/learn-github-actions/contexts#github-context diff --git a/services/console/src/chunks/docs-how-to/github-actions/es/pull-requests-fork-closed.mdx b/services/console/src/chunks/docs-how-to/github-actions/es/pull-requests-fork-closed.mdx index ac0e4a459..36cd3b9c3 100644 --- a/services/console/src/chunks/docs-how-to/github-actions/es/pull-requests-fork-closed.mdx +++ b/services/console/src/chunks/docs-how-to/github-actions/es/pull-requests-fork-closed.mdx @@ -16,40 +16,28 @@ Este flujo de trabajo archivará la rama del PR bifurcado utilizando el comando (ej: `on: pull_request: types: [closed]`) 3. Cree un `job` de GitHub Actions. (ej: `jobs: archive_pr_branch`) -4. Establezca [los permisos para el `GITHUB_TOKEN`][github token permissions] - en `write` para `pull-requests`. - Dependiendo de su configuración de GitHub, esto puede no ser necesario. - Pero para todas las organizaciones y repositorios personales - [creados después del 02 de febrero de 2023][github token read only], - este es el comportamiento predeterminado. - Consulte [la documentación de GitHub][github token permissions security] - para una visión completa. - (ej: `permissions: pull-requests: write`) -5. Establezca el tipo de máquina en la que se ejecutará el trabajo. +4. Establezca el tipo de máquina en la que se ejecutará el trabajo. Consulte la [documentación `runs-on` de GitHub Actions][github actions runs-on] para una visión completa. (ej: `runs-on: ubuntu-latest`) -6. Realice el checkout del código fuente de la rama del PR. +5. Realice el checkout del código fuente de la rama del PR. (ej: `uses: actions/checkout@v4`) -7. Instale el CLI de Bencher utilizando [la Acción de GitHub][bencher cli github action]. +6. Instale el CLI de Bencher utilizando [la Acción de GitHub][bencher cli github action]. (ej: `uses: bencherdev/bencher@main`) -8. Use el subcomando `bencher archive` de CLI para archivar la rama del PR. +7. Use el subcomando `bencher archive` de CLI para archivar la rama del PR. (ej: `bencher archive`) -9. Establezca la opción `--project` en el slug del Proyecto. +8. Establezca la opción `--project` en el slug del Proyecto. Consulte [los documentos `--project`][project option] para más detalles. (ej: `--project save-walter-white-1234abcd`) -10. Establezca la opción `--token` en el secreto **Repository** `BENCHER_API_TOKEN`. +9. Establezca la opción `--token` en el secreto **Repository** `BENCHER_API_TOKEN`. Consulte [los documentos `--token`][token option] para más detalles. (ej: `--token '${{ secrets.BENCHER_API_TOKEN }}'`) -11. Establezca la opción `--branch` en el nombre de la rama del PR +10. Establezca la opción `--branch` en el nombre de la rama del PR utilizando [el contexto `github` de GitHub Actions][github actions context]. (ej: `--branch '${{ github.head_ref }}'`) [github actions on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on [github action pull_request]: https://docs.github.com/en/webhooks/webhook-events-and-payloads#pull_request -[github token permissions]: https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs#setting-the-github_token-permissions-for-a-specific-job -[github token read only]: https://github.blog/changelog/2023-02-02-github-actions-updating-the-default-github_token-permissions-to-read-only/ -[github token permissions security]: https://docs.github.com/en/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token [github actions runs-on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on [bencher cli github action]: https://github.com/marketplace/actions/bencher-cli [github actions context]: https://docs.github.com/en/actions/learn-github-actions/contexts#github-context diff --git a/services/console/src/chunks/docs-how-to/github-actions/fr/base-branch.mdx b/services/console/src/chunks/docs-how-to/github-actions/fr/base-branch.mdx index 58f0db44b..85e2f6d7b 100644 --- a/services/console/src/chunks/docs-how-to/github-actions/fr/base-branch.mdx +++ b/services/console/src/chunks/docs-how-to/github-actions/fr/base-branch.mdx @@ -16,32 +16,35 @@ Cette base de référence historique peut alors être utilisée pour détecter l (ex: `on: push: branches: main`) 3. Créez un `job` GitHub Actions. (ex: `jobs: benchmark_base_branch`) -4. Définissez le type de machine sur laquelle le job sera exécuté. +4. Définissez [les autorisations pour le `GITHUB_TOKEN`][github token permissions] + sur `write` pour `checks`. + (ex : `permissions: checks: write`) +5. Définissez le type de machine sur laquelle le job sera exécuté. Consultez la [documentation GitHub Actions `runs-on`][github actions runs-on] pour un aperçu complet. (ex: `runs-on: ubuntu-latest`) -5. Récupérez le code source de votre branche de base. +6. Récupérez le code source de votre branche de base. (ex: `uses: actions/checkout@v4`) -6. Installez le Bencher CLI en utilisant [l'Action GitHub][bencher cli github action]. +7. Installez le Bencher CLI en utilisant [l'Action GitHub][bencher cli github action]. (ex: `uses: bencherdev/bencher@main`) -7. Utilisez la sous-commande CLI bencher run +8. Utilisez la sous-commande CLI bencher run pour exécuter vos benchmarks de la branche `main`. Consultez [la sous-commande CLI `bencher run`][bencher run] pour un aperçu complet. (ex: `bencher run`) -8. Définissez l'option `--project` sur le slug du Projet. +9. Définissez l'option `--project` sur le slug du Projet. Consultez [les documents `--project`][project option] pour plus de détails. (ex: `--project save-walter-white-1234abcd`) -9. Définissez l'option `--token` sur le secret **Repository** `BENCHER_API_TOKEN`. +10. Définissez l'option `--token` sur le secret **Repository** `BENCHER_API_TOKEN`. Consultez [les documents `--token`][token option] pour plus de détails. (ex: `--token '${{ secrets.BENCHER_API_TOKEN }}'`) -10. Définissez l'option `--branch` sur le nom de la branche de base. +11. Définissez l'option `--branch` sur le nom de la branche de base. Consultez [les documents `--branch`][branch option] pour un aperçu complet. (ex: `--branch main`) -11. Réglez l'option `--testbed` sur le nom du Testbed. +12. Réglez l'option `--testbed` sur le nom du Testbed. Cela devrait probablement correspondre à la machine sélectionnée dans `runs-on`. Consultez [les documents `--tested`][testbed option] pour plus de détails. (ex: `--testbed ubuntu-latest`) -12. Définissez le seuil pour la Branche `main`, le Testbed `ubuntu-latest`, et la Mesure `latency`: +13. Définissez le seuil pour la Branche `main`, le Testbed `ubuntu-latest`, et la Mesure `latency`: 1. Définissez l'option `--threshold-measure` sur la Mesure intégrée `latency` générée par bencher mock. Consultez [les documents `--threshold-measure`][threshold measure option] pour plus de détails. (ex: `--threshold-measure latency`) @@ -57,22 +60,23 @@ Cette base de référence historique peut alors être utilisée pour détecter l 5. Réglez l'indicateur `--thresholds-reset` pour que seul le seuil spécifié soit actif. Consultez [les documents `--thresholds-reset`][thresholds reset] pour un aperçu complet. (ex: `--thresholds-reset`) -13. Réglez l'indicateur `--err` pour échouer la commande si une Alerte est générée. +14. Réglez l'indicateur `--err` pour échouer la commande si une Alerte est générée. Consultez [les documents `--err`][alert err] pour un aperçu complet. (ex: `--err`) -14. Définissez l'option `--adapter` sur [Bencher Metric Format JSON (`json`)][bmf] qui est généré par bencher mock. +15. Définissez l'option `--adapter` sur [Bencher Metric Format JSON (`json`)][bmf] qui est généré par bencher mock. Consultez [les adaptateurs de harnais de benchmark][adapter json] pour un aperçu complet. (ex: `--adapter json`) -15. Réglez l'option `--github-actions` sur le jeton d'authentification API GitHub pour publier les résultats sous forme de commentaire de Vérifications GitHub en utilisant +16. Réglez l'option `--github-actions` sur le jeton d'authentification API GitHub pour publier les résultats sous forme de commentaire de Vérifications GitHub en utilisant [la variable d'environnement `GITHUB_TOKEN` de GitHub Actions][github token]. Consultez [les documents `--github-actions`][github actions option] pour plus de détails. (ex: `--github-actions '${{ secrets.GITHUB_TOKEN }}'`) -16. Spécifiez les arguments de la commande de benchmark. +17. Spécifiez les arguments de la commande de benchmark. Consultez [la commande de benchmark][command argument] pour un aperçu complet. (ex: `bencher mock`) [github actions on]: https://docs.github.com/fr/actions/using-workflows/workflow-syntax-for-github-actions#on [github actions push]: https://docs.github.com/fr/webhooks/webhook-events-and-payloads#push +[github token permissions]: https://docs.github.com/fr/actions/using-jobs/assigning-permissions-to-jobs#setting-the-github_token-permissions-for-a-specific-job [github actions runs-on]: https://docs.github.com/fr/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on [bencher cli github action]: https://github.com/marketplace/actions/bencher-cli [github token]: https://docs.github.com/fr/actions/security-guides/automatic-token-authentication diff --git a/services/console/src/chunks/docs-how-to/github-actions/fr/pull-requests-closed.mdx b/services/console/src/chunks/docs-how-to/github-actions/fr/pull-requests-closed.mdx index 3df965013..24d872974 100644 --- a/services/console/src/chunks/docs-how-to/github-actions/fr/pull-requests-closed.mdx +++ b/services/console/src/chunks/docs-how-to/github-actions/fr/pull-requests-closed.mdx @@ -20,41 +20,29 @@ Ce workflow archivera la branche de la PR en utilisant la commande `bencher arch ⚠️ NE SUPPRIMEZ PAS CETTE LIGNE ! Pour le traitement des PRs provenant de Forks, voir [Pull Requests depuis les Forks][pull requests from forks] ci-dessous. (ex: `if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository`) -5. Définissez [les autorisations pour le `GITHUB_TOKEN`][github token permissions] - à `write` pour `pull-requests`. - Selon vos paramètres GitHub, cela peut ne pas être nécessaire. - Mais pour tous les organisations et dépôts personnels - [créés après le 02 février 2023][github token read only], - ceci est le comportement par défaut. - Voir [la documentation GitHub][github token permissions security] - pour un aperçu complet. - (ex: `permissions: pull-requests: write`) -6. Définissez le type de machine sur lequel le job s'exécutera. +5. Définissez le type de machine sur lequel le job s'exécutera. Voir la [documentation GitHub Actions `runs-on`][github actions runs-on] pour un aperçu complet. (ex: `runs-on: ubuntu-latest`) -7. Validez le code source de la branche PR. +6. Validez le code source de la branche PR. (ex: `uses: actions/checkout@v4`) -8. Installez le Bencher CLI en utilisant [l'Action GitHub][bencher cli github action]. +7. Installez le Bencher CLI en utilisant [l'Action GitHub][bencher cli github action]. (ex: `uses: bencherdev/bencher@main`) -9. Utilisez la sous-commande CLI `bencher archive` pour archiver la branche PR. +8. Utilisez la sous-commande CLI `bencher archive` pour archiver la branche PR. (ex: `bencher archive`) -10. Définissez l'option `--project` sur le slug du Projet. +9. Définissez l'option `--project` sur le slug du Projet. Voir [les docs `--project`][project option] pour plus de détails. (ex: `--project save-walter-white-1234abcd`) -11. Définissez l'option `--token` sur le secret du **dépôt** `BENCHER_API_TOKEN`. +10. Définissez l'option `--token` sur le secret du **dépôt** `BENCHER_API_TOKEN`. Voir [les docs `--token`][token option] pour plus de détails. (ex: `--token '${{ secrets.BENCHER_API_TOKEN }}'`) -12. Définissez l'option `--branch` sur le nom de la branche PR +11. Définissez l'option `--branch` sur le nom de la branche PR en utilisant [le contexte `github` des GitHub Actions][github actions context]. (ex: `--branch '${{ github.head_ref }}'`) [github actions on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on [github action pull_request]: https://docs.github.com/en/webhooks/webhook-events-and-payloads#pull_request -[github token permissions]: https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs#setting-the-github_token-permissions-for-a-specific-job -[github token read only]: https://github.blog/changelog/2023-02-02-github-actions-updating-the-default-github_token-permissions-to-read-only/ -[github token permissions security]: https://docs.github.com/en/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token [github actions runs-on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on [bencher cli github action]: https://github.com/marketplace/actions/bencher-cli [github actions context]: https://docs.github.com/en/actions/learn-github-actions/contexts#github-context diff --git a/services/console/src/chunks/docs-how-to/github-actions/fr/pull-requests-fork-closed.mdx b/services/console/src/chunks/docs-how-to/github-actions/fr/pull-requests-fork-closed.mdx index 3c06f9464..f27ccdff8 100644 --- a/services/console/src/chunks/docs-how-to/github-actions/fr/pull-requests-fork-closed.mdx +++ b/services/console/src/chunks/docs-how-to/github-actions/fr/pull-requests-fork-closed.mdx @@ -16,40 +16,28 @@ Ce workflow archivera la branche de PR du fork en utilisant la commande `bencher (ex : `on: pull_request: types: [closed]`) 3. Créez un `job` GitHub Actions. (ex : `jobs: archive_pr_branch`) -4. Configurez [les permissions pour le `GITHUB_TOKEN`][github token permissions] - à `write` pour `pull-requests`. - Selon vos paramètres GitHub, cela peut ne pas être nécessaire. - Mais pour toutes les organisations et dépôts personnels - [créés après le 02 février 2023][github token read only], - c'est le comportement par défaut. - Consultez [la documentation GitHub][github token permissions security] - pour un aperçu complet. - (ex : `permissions: pull-requests: write`) -5. Définissez le type de machine sur laquelle le job s'exécutera. +4. Définissez le type de machine sur laquelle le job s'exécutera. Consultez la [documentation `runs-on` de GitHub Actions][github actions runs-on] pour un aperçu complet. (ex : `runs-on: ubuntu-latest`) -6. Récupérez le code source de la branche PR. +5. Récupérez le code source de la branche PR. (ex : `uses: actions/checkout@v4`) -7. Installez le CLI Bencher en utilisant [l'Action GitHub][bencher cli github action]. +6. Installez le CLI Bencher en utilisant [l'Action GitHub][bencher cli github action]. (ex : `uses: bencherdev/bencher@main`) -8. Utilisez la sous-commande `bencher archive` CLI pour archiver la branche PR. +7. Utilisez la sous-commande `bencher archive` CLI pour archiver la branche PR. (ex : `bencher archive`) -9. Définissez l'option `--project` sur le slug du projet. +8. Définissez l'option `--project` sur le slug du projet. Consultez [la documentation `--project`][project option] pour plus de détails. (ex : `--project save-walter-white-1234abcd`) -10. Configurez l'option `--token` sur le secret **Repository** `BENCHER_API_TOKEN`. +9. Configurez l'option `--token` sur le secret **Repository** `BENCHER_API_TOKEN`. Consultez [la documentation `--token`][token option] pour plus de détails. (ex : `--token '${{ secrets.BENCHER_API_TOKEN }}'`) -11. Configurez l'option `--branch` sur le nom de la branche PR +10. Configurez l'option `--branch` sur le nom de la branche PR en utilisant [le contexte `github` de GitHub Actions][github actions context]. (ex : `--branch '${{ github.head_ref }}'`) [github actions on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on [github action pull_request]: https://docs.github.com/en/webhooks/webhook-events-and-payloads#pull_request -[github token permissions]: https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs#setting-the-github_token-permissions-for-a-specific-job -[github token read only]: https://github.blog/changelog/2023-02-02-github-actions-updating-the-default-github_token-permissions-to-read-only/ -[github token permissions security]: https://docs.github.com/en/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token [github actions runs-on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on [bencher cli github action]: https://github.com/marketplace/actions/bencher-cli [github actions context]: https://docs.github.com/en/actions/learn-github-actions/contexts#github-context diff --git a/services/console/src/chunks/docs-how-to/github-actions/ja/base-branch.mdx b/services/console/src/chunks/docs-how-to/github-actions/ja/base-branch.mdx index df00a5ab9..9744e5548 100644 --- a/services/console/src/chunks/docs-how-to/github-actions/ja/base-branch.mdx +++ b/services/console/src/chunks/docs-how-to/github-actions/ja/base-branch.mdx @@ -14,30 +14,33 @@ import BaseBranchCode from "../base-branch-code.mdx"; （例: `on: push: branches: main`） 3. GitHub Actionsの`job`を作成します。 （例: `jobs: benchmark_base_branch`） -4. ジョブを実行するマシンのタイプを設定します。 +4. `GITHUB_TOKEN`の[権限を設定します][github token permissions] + `checks`に対して`write`を設定してください。 + （例：`permissions: checks: write`） +5. ジョブを実行するマシンのタイプを設定します。 詳細については、[GitHub Actionsの`runs-on`ドキュメント][github actions runs-on]を参照してください。 （例: `runs-on: ubuntu-latest`） -5. ベースブランチのソースコードをチェックアウトします。 +6. ベースブランチのソースコードをチェックアウトします。 （例: `uses: actions/checkout@v4`） -6. [GitHub Action][bencher cli github action]を使用してBencher CLIをインストールします。 +7. [GitHub Action][bencher cli github action]を使用してBencher CLIをインストールします。 （例: `uses: bencherdev/bencher@main`） -7. bencher run CLIサブコマンドを使用して`main`ブランチのベンチマークを実行します。 +8. bencher run CLIサブコマンドを使用して`main`ブランチのベンチマークを実行します。 詳細については、[`bencher run` CLIサブコマンド][bencher run]を参照してください。 （例: `bencher run`） -8. `--project`オプションをプロジェクトスラッグに設定します。 +9. `--project`オプションをプロジェクトスラッグに設定します。 詳細については、[`--project` ドキュメント][project option]を参照してください。 （例: `--project save-walter-white-1234abcd`） -9. `--token`オプションを`BENCHER_API_TOKEN` **リポジトリ**シークレットに設定します。 +10. `--token`オプションを`BENCHER_API_TOKEN` **リポジトリ**シークレットに設定します。 詳細については、[`--token` ドキュメント][token option]を参照してください。 （例: `--token '${{ secrets.BENCHER_API_TOKEN }}'`） -10. `--branch`オプションをベースブランチ名に設定します。 +11. `--branch`オプションをベースブランチ名に設定します。 詳細については、[`--branch` ドキュメント][branch option]を参照してください。 （例: `--branch main`） -11. `--testbed`オプションをテストベッド名に設定します。 +12. `--testbed`オプションをテストベッド名に設定します。 これは、`runs-on`で選択されたマシンと一致する必要があります。 詳細については、[`--testbed` ドキュメント][testbed option]を参照してください。 （例: `--testbed ubuntu-latest`） -12. `main`ブランチ、`ubuntu-latest`テストベッド、`latency`測定のしきい値を設定します： +13. `main`ブランチ、`ubuntu-latest`テストベッド、`latency`測定のしきい値を設定します： 1. `--threshold-measure`オプションをbencher mockによって生成される組み込みの`latency`測定に設定します。 詳細については、[`--threshold-measure` ドキュメント][threshold measure option]を参照してください。 （例: `--threshold-measure latency`） @@ -53,24 +56,25 @@ import BaseBranchCode from "../base-branch-code.mdx"; 5. 指定されたしきい値のみをアクティブにするために`--thresholds-reset`フラグを設定します。 詳細については、[`--thresholds-reset` ドキュメント][thresholds reset]を参照してください。 （例: `--thresholds-reset`） -13. 警告が生成された場合にコマンドを失敗させるように`--err`フラグを設定します。 +14. 警告が生成された場合にコマンドを失敗させるように`--err`フラグを設定します。 詳細については、[`--err` ドキュメント][alert err]を参照してください。 （例: `--err`） -14. bencher mockによって生成される[Bencher Metric Format JSON（`json`）][bmf]を`--adapter`オプションに設定します。 +15. bencher mockによって生成される[Bencher Metric Format JSON（`json`）][bmf]を`--adapter`オプションに設定します。 詳細については、[ベンチマークハーネスアダプタ][adapter json]を参照してください。 （例: `--adapter json`） -15. 結果をGitHub Checksコメントとして投稿するために、[GitHub Actions `GITHUB_TOKEN` 環境変数][github token]を使用して、`--github-actions`オプションをGitHub API認証トークンに設定します。 +16. 結果をGitHub Checksコメントとして投稿するために、[GitHub Actions `GITHUB_TOKEN` 環境変数][github token]を使用して、`--github-actions`オプションをGitHub API認証トークンに設定します。 詳細については、[`--github-actions` ドキュメント][github actions option]を参照してください。 （例: `--github-actions '${{ secrets.GITHUB_TOKEN }}'`） -16. ベンチマークコマンド引数を指定します。 +17. ベンチマークコマンド引数を指定します。 詳細については、[ベンチマークコマンド][command argument]を参照してください。 （例: `bencher mock`） -[github actions on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on -[github actions push]: https://docs.github.com/en/webhooks/webhook-events-and-payloads#push -[github actions runs-on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on +[github actions on]: https://docs.github.com/ja/actions/using-workflows/workflow-syntax-for-github-actions#on +[github actions push]: https://docs.github.com/ja/webhooks/webhook-events-and-payloads#push +[github token permissions]: https://docs.github.com/ja/actions/using-jobs/assigning-permissions-to-jobs#setting-the-github_token-permissions-for-a-specific-job +[github actions runs-on]: https://docs.github.com/ja/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on [bencher cli github action]: https://github.com/marketplace/actions/bencher-cli -[github token]: https://docs.github.com/en/actions/security-guides/automatic-token-authentication +[github token]: https://docs.github.com/ja/actions/security-guides/automatic-token-authentication [statistical continuous benchmarking]: /ja/docs/how-to/track-benchmarks/#statistical-continuous-benchmarking [bencher run]: /ja/docs/explanation/bencher-run/ diff --git a/services/console/src/chunks/docs-how-to/github-actions/ja/pull-requests-closed.mdx b/services/console/src/chunks/docs-how-to/github-actions/ja/pull-requests-closed.mdx index 64bcf7e36..d6c27ad11 100644 --- a/services/console/src/chunks/docs-how-to/github-actions/ja/pull-requests-closed.mdx +++ b/services/console/src/chunks/docs-how-to/github-actions/ja/pull-requests-closed.mdx @@ -17,37 +17,27 @@ GitHubのPRがクローズされた後にPRブランチをクリーンアップ ⚠️ この行を削除しないでください！ フォークからのPRを処理する方法については、以下の[フォークからのプルリクエスト][pull requests from forks]を参照してください。 (例: `if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository`) -5. `GITHUB_TOKEN`の[権限を設定][github token permissions] - `pull-requests`に対して`write`にします。 - GitHubの設定によって、これは必要ない場合がありますが、 - 2023年2月2日以降に作成されたすべての組織および個人リポジトリについては、 - [これはデフォルトの動作です][github token read only]。 - 詳細は[GitHubのドキュメント][github token permissions security]を参照してください。 - (例: `permissions: pull-requests: write`) -6. ジョブが実行されるマシンのタイプを設定します。 +5. ジョブが実行されるマシンのタイプを設定します。 詳細は[GitHub Actionsの`runs-on`ドキュメント][github actions runs-on]を参照してください。 (例: `runs-on: ubuntu-latest`) -7. PRブランチのソースコードをチェックアウトします。 +6. PRブランチのソースコードをチェックアウトします。 (例: `uses: actions/checkout@v4`) -8. Bencher CLIを[GitHub Actionを使用して][bencher cli github action]インストールします。 +7. Bencher CLIを[GitHub Actionを使用して][bencher cli github action]インストールします。 (例: `uses: bencherdev/bencher@main`) -9. `bencher archive` CLIサブコマンドを使用してPRブランチをアーカイブします。 +8. `bencher archive` CLIサブコマンドを使用してPRブランチをアーカイブします。 (例: `bencher archive`) -10. プロジェクトスラッグに`--project`オプションを設定します。 +9. プロジェクトスラッグに`--project`オプションを設定します。 詳細は[`--project`のドキュメント][project option]を参照してください。 (例: `--project save-walter-white-1234abcd`) -11. `--token`オプションを`BENCHER_API_TOKEN` **リポジトリ**シークレットに設定します。 +10. `--token`オプションを`BENCHER_API_TOKEN` **リポジトリ**シークレットに設定します。 詳細は[`--token`のドキュメント][token option]を参照してください。 (例: `--token '${{ secrets.BENCHER_API_TOKEN }}'`) -12. GitHub Actionsの`github`コンテキストを使用して、PRブランチ名に`--branch`オプションを設定します。 +11. GitHub Actionsの`github`コンテキストを使用して、PRブランチ名に`--branch`オプションを設定します。 (例: `--branch '${{ github.head_ref }}'`) [github actions on]: https://docs.github.com/ja/actions/using-workflows/workflow-syntax-for-github-actions#on [github action pull_request]: https://docs.github.com/ja/webhooks/webhook-events-and-payloads#pull_request -[github token permissions]: https://docs.github.com/ja/actions/using-jobs/assigning-permissions-to-jobs#setting-the-github_token-permissions-for-a-specific-job -[github token read only]: https://github.blog/changelog/2023-02-02-github-actions-updating-the-default-github_token-permissions-to-read-only/ -[github token permissions security]: https://docs.github.com/ja/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token [github actions runs-on]: https://docs.github.com/ja/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on [bencher cli github action]: https://github.com/marketplace/actions/bencher-cli [github actions context]: https://docs.github.com/ja/actions/learn-github-actions/contexts#github-context diff --git a/services/console/src/chunks/docs-how-to/github-actions/ja/pull-requests-fork-closed.mdx b/services/console/src/chunks/docs-how-to/github-actions/ja/pull-requests-fork-closed.mdx index 78348171f..86587ee07 100644 --- a/services/console/src/chunks/docs-how-to/github-actions/ja/pull-requests-fork-closed.mdx +++ b/services/console/src/chunks/docs-how-to/github-actions/ja/pull-requests-fork-closed.mdx @@ -14,36 +14,26 @@ import PullRequestsForkClosedCode from "../pull-requests-fork-closed-code.mdx"; (例: `on: pull_request: types: [closed]`) 3. GitHub Actions `job` を作成します。 (例: `jobs: archive_pr_branch`) -4. `GITHUB_TOKEN` の[権限を設定][github token permissions] - し、`pull-requests` に対して `write` にします。 - GitHubの設定によっては、これが不要な場合があります。 - ただし、[2023年2月2日以降に作成された][github token read only] - すべての組織と個人のリポジトリでは、これがデフォルトの動作です。 - 詳細は[GitHubドキュメント][github token permissions security]を参照してください。 - (例: `permissions: pull-requests: write`) -5. ジョブを実行するマシンの種類を設定します。 +4. ジョブを実行するマシンの種類を設定します。 詳細は[GitHub Actions `runs-on` ドキュメント][github actions runs-on]を参照してください。 (例: `runs-on: ubuntu-latest`) -6. PRブランチのソースコードをチェックアウトします。 +5. PRブランチのソースコードをチェックアウトします。 (例: `uses: actions/checkout@v4`) -7. [GitHub Action][bencher cli github action]を使用してBencher CLIをインストールします。 +6. [GitHub Action][bencher cli github action]を使用してBencher CLIをインストールします。 (例: `uses: bencherdev/bencher@main`) -8. PRブランチをアーカイブするために、`bencher archive` CLIサブコマンドを使用します。 +7. PRブランチをアーカイブするために、`bencher archive` CLIサブコマンドを使用します。 (例: `bencher archive`) -9. `--project` オプションをプロジェクトスラッグに設定します。 +8. `--project` オプションをプロジェクトスラッグに設定します。 詳細は[`--project` ドキュメント][project option]を参照してください。 (例: `--project save-walter-white-1234abcd`) -10. `--token` オプションを `BENCHER_API_TOKEN` **リポジトリ**シークレットに設定します。 +9. `--token` オプションを `BENCHER_API_TOKEN` **リポジトリ**シークレットに設定します。 詳細は[`--token` ドキュメント][token option]を参照してください。 (例: `--token '${{ secrets.BENCHER_API_TOKEN }}'`) -11. [GitHub Actions `github` コンテキスト][github actions context]を使用してPRブランチ名を`--branch` オプションに設定します。 +10. [GitHub Actions `github` コンテキスト][github actions context]を使用してPRブランチ名を`--branch` オプションに設定します。 (例: `--branch '${{ github.head_ref }}'`) [github actions on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on [github action pull_request]: https://docs.github.com/en/webhooks/webhook-events-and-payloads#pull_request -[github token permissions]: https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs#setting-the-github_token-permissions-for-a-specific-job -[github token read only]: https://github.blog/changelog/2023-02-02-github-actions-updating-the-default-github_token-permissions-to-read-only/ -[github token permissions security]: https://docs.github.com/en/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token [github actions runs-on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on [bencher cli github action]: https://github.com/marketplace/actions/bencher-cli [github actions context]: https://docs.github.com/en/actions/learn-github-actions/contexts#github-context diff --git a/services/console/src/chunks/docs-how-to/github-actions/ko/base-branch.mdx b/services/console/src/chunks/docs-how-to/github-actions/ko/base-branch.mdx index bf339da3f..b9dfc94aa 100644 --- a/services/console/src/chunks/docs-how-to/github-actions/ko/base-branch.mdx +++ b/services/console/src/chunks/docs-how-to/github-actions/ko/base-branch.mdx @@ -14,30 +14,33 @@ import BaseBranchCode from "../base-branch-code.mdx"; (예: `on: push: branches: main`) 3. GitHub Actions `job`을 생성하세요. (예: `jobs: benchmark_base_branch`) -4. 작업이 실행될 머신의 유형을 설정하세요. +4. [`GITHUB_TOKEN`의 권한을 설정하십시오][github token permissions] + `checks`에 대해 `write`로 설정합니다. + (예: `permissions: checks: write`) +5. 작업이 실행될 머신의 유형을 설정하세요. 전체 개요는 [GitHub Actions `runs-on` 문서][github actions runs-on]를 참조하세요. (예: `runs-on: ubuntu-latest`) -5. 기본 브랜치 소스 코드를 체크아웃하세요. +6. 기본 브랜치 소스 코드를 체크아웃하세요. (예: `uses: actions/checkout@v4`) -6. [GitHub Action][bencher cli github action]을 사용하여 Bencher CLI를 설치하세요. +7. [GitHub Action][bencher cli github action]을 사용하여 Bencher CLI를 설치하세요. (예: `uses: bencherdev/bencher@main`) -7. bencher run CLI 서브 커맨드를 사용하여 `main` 브랜치 벤치마크를 실행하세요. +8. bencher run CLI 서브 커맨드를 사용하여 `main` 브랜치 벤치마크를 실행하세요. 전체 개요는 [`bencher run` CLI 서브 커맨드][bencher run]를 참조하세요. (예: `bencher run`) -8. `--project` 옵션을 프로젝트 슬러그로 설정하세요. +9. `--project` 옵션을 프로젝트 슬러그로 설정하세요. 자세한 내용은 [`--project` 문서][project option]를 참조하세요. (예: `--project save-walter-white-1234abcd`) -9. `--token` 옵션을 `BENCHER_API_TOKEN` **레포지토리** 비밀로 설정하세요. +10. `--token` 옵션을 `BENCHER_API_TOKEN` **레포지토리** 비밀로 설정하세요. 자세한 내용은 [`--token` 문서][token option]를 참조하세요. (예: `--token '${{ secrets.BENCHER_API_TOKEN }}'`) -10. `--branch` 옵션을 기본 브랜치 이름으로 설정하세요. +11. `--branch` 옵션을 기본 브랜치 이름으로 설정하세요. 전체 개요는 [`--branch` 문서][branch option]를 참조하세요. (예: `--branch main`) -11. `--testbed` 옵션을 테스트베드 이름으로 설정하세요. +12. `--testbed` 옵션을 테스트베드 이름으로 설정하세요. 이는 아마도 `runs-on`에 선택된 머신과 일치해야 합니다. 자세한 내용은 [`--tested` 문서][testbed option]를 참조하세요. (예: `--testbed ubuntu-latest`) -12. `main` 브랜치, `ubuntu-latest` 테스트베드, `latency` 측정을 위한 임계값을 설정하세요: +13. `main` 브랜치, `ubuntu-latest` 테스트베드, `latency` 측정을 위한 임계값을 설정하세요: 1. `--threshold-measure` 옵션을 bencher mock에 의해 생성된 기본 `latency` 측정값으로 설정하세요. 자세한 내용은 [`--threshold-measure` 문서][threshold measure option]를 참조하세요. (예: `--threshold-measure latency`) @@ -53,24 +56,25 @@ import BaseBranchCode from "../base-branch-code.mdx"; 5. `--thresholds-reset` 플래그를 설정하여 지정된 임계값만 활성 상태가 되도록 하세요. 전체 개요는 [`--thresholds-reset` 문서][thresholds reset]를 참조하세요. (예: `--thresholds-reset`) -13. 알림이 생성되면 명령을 실패하도록 `--err` 플래그를 설정하세요. +14. 알림이 생성되면 명령을 실패하도록 `--err` 플래그를 설정하세요. 전체 개요는 [`--err` 문서][alert err]를 참조하세요. (예: `--err`) -14. [Bencher Metric Format JSON (`json`)][bmf]에 대해 `--adapter` 옵션을 설정하세요. 이 형식은 bencher mock에 의해 생성됩니다. +15. [Bencher Metric Format JSON (`json`)][bmf]에 대해 `--adapter` 옵션을 설정하세요. 이 형식은 bencher mock에 의해 생성됩니다. 전체 개요는 [벤치마크 하니스 어댑터][adapter json]를 참조하세요. (예: `--adapter json`) -15. GitHub Checks 댓글로 결과를 게시하기 위해 [GitHub Actions `GITHUB_TOKEN` 환경 변수][github token]를 사용하여 GitHub API 인증 토큰을 `--github-actions` 옵션에 설정하세요. +16. GitHub Checks 댓글로 결과를 게시하기 위해 [GitHub Actions `GITHUB_TOKEN` 환경 변수][github token]를 사용하여 GitHub API 인증 토큰을 `--github-actions` 옵션에 설정하세요. 자세한 내용은 [`--github-actions` 문서][github actions option]를 참조하세요. (예: `--github-actions '${{ secrets.GITHUB_TOKEN }}'`) -16. 벤치마크 명령 인수를 지정하세요. +17. 벤치마크 명령 인수를 지정하세요. 전체 개요는 [벤치마크 명령][command argument]를 참조하세요. (예: `bencher mock`) -[github actions on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on -[github actions push]: https://docs.github.com/en/webhooks/webhook-events-and-payloads#push -[github actions runs-on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on +[github actions on]: https://docs.github.com/ko/actions/using-workflows/workflow-syntax-for-github-actions#on +[github actions push]: https://docs.github.com/ko/webhooks/webhook-events-and-payloads#push +[github token permissions]: https://docs.github.com/ko/actions/using-jobs/assigning-permissions-to-jobs#setting-the-github_token-permissions-for-a-specific-job +[github actions runs-on]: https://docs.github.com/ko/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on [bencher cli github action]: https://github.com/marketplace/actions/bencher-cli -[github token]: https://docs.github.com/en/actions/security-guides/automatic-token-authentication +[github token]: https://docs.github.com/ko/actions/security-guides/automatic-token-authentication [statistical continuous benchmarking]: /ko/docs/how-to/track-benchmarks/#statistical-continuous-benchmarking [bencher run]: /ko/docs/explanation/bencher-run/ diff --git a/services/console/src/chunks/docs-how-to/github-actions/ko/pull-requests-closed.mdx b/services/console/src/chunks/docs-how-to/github-actions/ko/pull-requests-closed.mdx index 53b9b9080..c0f76d689 100644 --- a/services/console/src/chunks/docs-how-to/github-actions/ko/pull-requests-closed.mdx +++ b/services/console/src/chunks/docs-how-to/github-actions/ko/pull-requests-closed.mdx @@ -19,37 +19,28 @@ PR이 닫힌 후 해당 브랜치를 정리하기 위해서, ⚠️ 이 줄은 절대 삭제하지 마세요! Fork PRs를 처리하려면 아래의 [Pull Requests from Forks][pull requests from forks]를 참조하세요. (예: `if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository`) -5. [GITHUB_TOKEN의 권한][github token permissions]을 `pull-requests`에 대해서 `write`로 설정하세요. - GitHub 설정에 따라 이 설정이 필요하지 않을 수 있습니다. - 그러나 2023년 2월 2일 이후에 [생성된 모든 조직 및 개인 저장소][github token read only]에 대해 - 이것이 기본 동작입니다. - 전체 개요는 [GitHub 설명서][github token permissions security]를 참조하세요. - (예: `permissions: pull-requests: write`) -6. 작업이 실행될 머신의 유형을 설정하세요. +5. 작업이 실행될 머신의 유형을 설정하세요. 전체 개요는 [GitHub Actions `runs-on` 설명서][github actions runs-on]를 참조하세요. (예: `runs-on: ubuntu-latest`) -7. PR 브랜치 소스 코드를 체크아웃하세요. +6. PR 브랜치 소스 코드를 체크아웃하세요. (예: `uses: actions/checkout@v4`) -8. [GitHub Action][bencher cli github action]을 사용하여 Bencher CLI를 설치하세요. +7. [GitHub Action][bencher cli github action]을 사용하여 Bencher CLI를 설치하세요. (예: `uses: bencherdev/bencher@main`) -9. `bencher archive` CLI 하위 명령을 사용하여 PR 브랜치를 아카이브하세요. +8. `bencher archive` CLI 하위 명령을 사용하여 PR 브랜치를 아카이브하세요. (예: `bencher archive`) -10. `--project` 옵션을 프로젝트 슬러그로 설정하세요. +9. `--project` 옵션을 프로젝트 슬러그로 설정하세요. 자세한 내용은 [--project 설명서][project option]를 참조하세요. (예: `--project save-walter-white-1234abcd`) -11. `--token` 옵션을 **저장소** 비밀로 설정된 `BENCHER_API_TOKEN`으로 설정하세요. +10. `--token` 옵션을 **저장소** 비밀로 설정된 `BENCHER_API_TOKEN`으로 설정하세요. 자세한 내용은 [--token 설명서][token option]를 참조하세요. (예: `--token '${{ secrets.BENCHER_API_TOKEN }}'`) -12. [GitHub Actions `github` 컨텍스트][github actions context]를 사용하여 +11. [GitHub Actions `github` 컨텍스트][github actions context]를 사용하여 PR 브랜치 이름을 `--branch` 옵션으로 설정하세요. (예: `--branch '${{ github.head_ref }}'`) [github actions on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on [github action pull_request]: https://docs.github.com/en/webhooks/webhook-events-and-payloads#pull_request -[github token permissions]: https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs#setting-the-github_token-permissions-for-a-specific-job -[github token read only]: https://github.blog/changelog/2023-02-02-github-actions-updating-the-default-github_token-permissions-to-read-only/ -[github token permissions security]: https://docs.github.com/en/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token [github actions runs-on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on [bencher cli github action]: https://github.com/marketplace/actions/bencher-cli [github actions context]: https://docs.github.com/en/actions/learn-github-actions/contexts#github-context diff --git a/services/console/src/chunks/docs-how-to/github-actions/ko/pull-requests-fork-closed.mdx b/services/console/src/chunks/docs-how-to/github-actions/ko/pull-requests-fork-closed.mdx index f37fd7835..0e0769633 100644 --- a/services/console/src/chunks/docs-how-to/github-actions/ko/pull-requests-fork-closed.mdx +++ b/services/console/src/chunks/docs-how-to/github-actions/ko/pull-requests-fork-closed.mdx @@ -16,37 +16,27 @@ PR이 닫힌 후 포크 PR 브랜치를 정리하려면, (예: `on: pull_request: types: [closed]`) 3. GitHub Actions `job`을 생성합니다. (예: `jobs: archive_pr_branch`) -4. `GITHUB_TOKEN`의 [권한을 설정][github token permissions]하여 - `pull-requests`에 대해 `write`로 설정합니다. - GitHub 설정에 따라 필요하지 않을 수 있습니다. - 그러나 2023년 2월 2일 이후 [생성된 모든 조직 및 개인 저장소][github token read only]의 경우, - 이것이 기본 동작입니다. - 전체 개요는 [GitHub 문서][github token permissions security]를 참조하세요. - (예: `permissions: pull-requests: write`) -5. 작업이 실행될 머신 유형을 설정하세요. +4. 작업이 실행될 머신 유형을 설정하세요. 전체 개요는 [GitHub Actions `runs-on` 문서][github actions runs-on]를 참고하세요. (예: `runs-on: ubuntu-latest`) -6. PR 브랜치 소스 코드를 체크아웃합니다. +5. PR 브랜치 소스 코드를 체크아웃합니다. (예: `uses: actions/checkout@v4`) -7. [GitHub Action][bencher cli github action]을 사용하여 Bencher CLI를 설치합니다. +6. [GitHub Action][bencher cli github action]을 사용하여 Bencher CLI를 설치합니다. (예: `uses: bencherdev/bencher@main`) -8. `bencher archive` CLI 하위 명령을 사용하여 PR 브랜치를 아카이브합니다. +7. `bencher archive` CLI 하위 명령을 사용하여 PR 브랜치를 아카이브합니다. (예: `bencher archive`) -9. `--project` 옵션을 프로젝트 슬러그로 설정합니다. +8. `--project` 옵션을 프로젝트 슬러그로 설정합니다. 자세한 내용은 [`--project` 문서][project option]를 참조하세요. (예: `--project save-walter-white-1234abcd`) -10. `--token` 옵션을 `BENCHER_API_TOKEN` **저장소** 비밀로 설정합니다. +9. `--token` 옵션을 `BENCHER_API_TOKEN` **저장소** 비밀로 설정합니다. 자세한 내용은 [`--token` 문서][token option]를 참고하세요. (예: `--token '${{ secrets.BENCHER_API_TOKEN }}'`) -11. [GitHub Actions `github` 컨텍스트][github actions context]를 사용하여 PR 브랜치 이름으로 +10. [GitHub Actions `github` 컨텍스트][github actions context]를 사용하여 PR 브랜치 이름으로 `--branch` 옵션을 설정합니다. (예: `--branch '${{ github.head_ref }}'`) [github actions on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on [github action pull_request]: https://docs.github.com/en/webhooks/webhook-events-and-payloads#pull_request -[github token permissions]: https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs#setting-the-github_token-permissions-for-a-specific-job -[github token read only]: https://github.blog/changelog/2023-02-02-github-actions-updating-the-default-github_token-permissions-to-read-only/ -[github token permissions security]: https://docs.github.com/en/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token [github actions runs-on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on [bencher cli github action]: https://github.com/marketplace/actions/bencher-cli [github actions context]: https://docs.github.com/en/actions/learn-github-actions/contexts#github-context diff --git a/services/console/src/chunks/docs-how-to/github-actions/pt/base-branch.mdx b/services/console/src/chunks/docs-how-to/github-actions/pt/base-branch.mdx index aba80aa31..0010ed2c7 100644 --- a/services/console/src/chunks/docs-how-to/github-actions/pt/base-branch.mdx +++ b/services/console/src/chunks/docs-how-to/github-actions/pt/base-branch.mdx @@ -16,32 +16,35 @@ Essa linha de base histórica pode então ser usada para detectar regressões de (ex: `on: push: branches: main`) 3. Crie um `job` do GitHub Actions. (ex: `jobs: benchmark_base_branch`) -4. Defina o tipo de máquina em que o job será executado. +4. Defina [as permissões para o `GITHUB_TOKEN`][github token permissions] + como `write` para `checks`. + (ex: `permissions: checks: write`) +5. Defina o tipo de máquina em que o job será executado. Veja a [documentação de `runs-on` do GitHub Actions][github actions runs-on] para uma visão geral completa. (ex: `runs-on: ubuntu-latest`) -5. Faça o checkout do código-fonte da sua ramificação base. +6. Faça o checkout do código-fonte da sua ramificação base. (ex: `uses: actions/checkout@v4`) -6. Instale o Bencher CLI usando [a Ação do GitHub][bencher cli github action]. +7. Instale o Bencher CLI usando [a Ação do GitHub][bencher cli github action]. (ex: `uses: bencherdev/bencher@main`) -7. Use o subcomando bencher run do CLI +8. Use o subcomando bencher run do CLI para executar os benchmarks da sua ramificação `main`. Veja [o subcomando `bencher run` do CLI][bencher run] para uma visão geral completa. (ex: `bencher run`) -8. Configure a opção `--project` para o slug do Projeto. +9. Configure a opção `--project` para o slug do Projeto. Veja [os documentos de `--project`][project option] para mais detalhes. (ex: `--project save-walter-white-1234abcd`) -9. Configure a opção `--token` para o segredo **Repositorio** `BENCHER_API_TOKEN`. +10. Configure a opção `--token` para o segredo **Repositorio** `BENCHER_API_TOKEN`. Veja [os documentos de `--token`][token option] para mais detalhes. (ex: `--token '${{ secrets.BENCHER_API_TOKEN }}'`) -10. Configure a opção `--branch` para o nome da Ramificação base. +11. Configure a opção `--branch` para o nome da Ramificação base. Veja [os documentos de `--branch`][branch option] para uma visão geral completa. (ex: `--branch main`) -11. Configure a opção `--testbed` para o nome do Testbed. +12. Configure a opção `--testbed` para o nome do Testbed. Isso deve provavelmente coincidir com a máquina selecionada em `runs-on`. Veja [os documentos de `--tested`][testbed option] para mais detalhes. (ex: `--testbed ubuntu-latest`) -12. Configure o Limite para a Ramificação `main`, Testbed `ubuntu-latest`, e Medida `latency`: +13. Configure o Limite para a Ramificação `main`, Testbed `ubuntu-latest`, e Medida `latency`: 1. Configure a opção `--threshold-measure` para a medida `latency` embutida que é gerada por bencher mock. Veja [os documentos de `--threshold-measure`][threshold measure option] para mais detalhes. (ex: `--threshold-measure latency`) @@ -57,25 +60,26 @@ Essa linha de base histórica pode então ser usada para detectar regressões de 5. Defina a flag `--thresholds-reset` para que somente o Limite especificado esteja ativo. Veja [os documentos de `--thresholds-reset`][thresholds reset] para uma visão geral completa. (ex: `--thresholds-reset`) -13. Defina a flag `--err` para falhar o comando se um Alerta for gerado. +14. Defina a flag `--err` para falhar o comando se um Alerta for gerado. Veja [os documentos de `--err`][alert err] para uma visão geral completa. (ex: `--err`) -14. Configure a opção `--adapter` para o [Bencher Metric Format JSON (`json`)][bmf] que é gerado por bencher mock. +15. Configure a opção `--adapter` para o [Bencher Metric Format JSON (`json`)][bmf] que é gerado por bencher mock. Veja [adapters do harness de benchmark][adapter json] para uma visão geral completa. (ex: `--adapter json`) -15. Configure a opção `--github-actions` para o token de autenticação da API do GitHub para publicar resultados como um comentário de Checks do GitHub usando +16. Configure a opção `--github-actions` para o token de autenticação da API do GitHub para publicar resultados como um comentário de Checks do GitHub usando [a variável de ambiente `GITHUB_TOKEN` do GitHub Actions][github token]. Veja [os documentos de `--github-actions`][github actions option] para mais detalhes. (ex: `--github-actions '${{ secrets.GITHUB_TOKEN }}'`) -16. Especifique os argumentos do comando de benchmark. +17. Especifique os argumentos do comando de benchmark. Veja [comando de benchmark][command argument] para uma visão geral completa. (ex: `bencher mock`) -[github actions on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on -[github actions push]: https://docs.github.com/en/webhooks/webhook-events-and-payloads#push -[github actions runs-on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on +[github actions on]: https://docs.github.com/pt/actions/using-workflows/workflow-syntax-for-github-actions#on +[github actions push]: https://docs.github.com/pt/webhooks/webhook-events-and-payloads#push +[github token permissions]: https://docs.github.com/pt/actions/using-jobs/assigning-permissions-to-jobs#setting-the-github_token-permissions-for-a-specific-job +[github actions runs-on]: https://docs.github.com/pt/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on [bencher cli github action]: https://github.com/marketplace/actions/bencher-cli -[github token]: https://docs.github.com/en/actions/security-guides/automatic-token-authentication +[github token]: https://docs.github.com/pt/actions/security-guides/automatic-token-authentication [statistical continuous benchmarking]: /pt/docs/how-to/track-benchmarks/#statistical-continuous-benchmarking [bencher run]: /pt/docs/explanation/bencher-run/ diff --git a/services/console/src/chunks/docs-how-to/github-actions/pt/pull-requests-closed.mdx b/services/console/src/chunks/docs-how-to/github-actions/pt/pull-requests-closed.mdx index 6053e0db1..48de7e7fb 100644 --- a/services/console/src/chunks/docs-how-to/github-actions/pt/pull-requests-closed.mdx +++ b/services/console/src/chunks/docs-how-to/github-actions/pt/pull-requests-closed.mdx @@ -20,41 +20,29 @@ Este fluxo de trabalho arquivará a branch do PR usando o comando `bencher archi ⚠️ NÃO REMOVA ESTA LINHA! Para lidar com PRs de Forks veja [Pull Requests de Forks][pull requests from forks] abaixo. (ex: `if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository`) -5. Defina [as permissões para o `GITHUB_TOKEN`][github token permissions] - como `write` para `pull-requests`. - Dependendo das suas configurações do GitHub, isso pode não ser necessário. - Mas para todas as organizações e repositórios pessoais - [criados após 02 de fevereiro de 2023][github token read only], - este é o comportamento padrão. - Veja [a documentação do GitHub][github token permissions security] - para uma visão geral completa. - (ex: `permissions: pull-requests: write`) -6. Defina o tipo de máquina no qual o job será executado. +5. Defina o tipo de máquina no qual o job será executado. Veja a [documentação do `runs-on` do GitHub Actions][github actions runs-on] para uma visão geral completa. (ex: `runs-on: ubuntu-latest`) -7. Faça checkout do código fonte da branch do PR. +6. Faça checkout do código fonte da branch do PR. (ex: `uses: actions/checkout@v4`) -8. Instale o Bencher CLI usando [a Ação do GitHub][bencher cli github action]. +7. Instale o Bencher CLI usando [a Ação do GitHub][bencher cli github action]. (ex: `uses: bencherdev/bencher@main`) -9. Use o subcomando `bencher archive` da CLI para arquivar a branch do PR. +8. Use o subcomando `bencher archive` da CLI para arquivar a branch do PR. (ex: `bencher archive`) -10. Defina a opção `--project` para o slug do Projeto. +9. Defina a opção `--project` para o slug do Projeto. Veja [os documentos do `--project`][project option] para mais detalhes. (ex: `--project save-walter-white-1234abcd`) -11. Defina a opção `--token` para o segredo **Repositório** `BENCHER_API_TOKEN`. +10. Defina a opção `--token` para o segredo **Repositório** `BENCHER_API_TOKEN`. Veja [os documentos do `--token`][token option] para mais detalhes. (ex: `--token '${{ secrets.BENCHER_API_TOKEN }}'`) -12. Defina a opção `--branch` para o nome da branch do PR +11. Defina a opção `--branch` para o nome da branch do PR usando [o contexto `github` do GitHub Actions][github actions context]. (ex: `--branch '${{ github.head_ref }}'`) [github actions on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on [github action pull_request]: https://docs.github.com/en/webhooks/webhook-events-and-payloads#pull_request -[github token permissions]: https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs#setting-the-github_token-permissions-for-a-specific-job -[github token read only]: https://github.blog/changelog/2023-02-02-github-actions-updating-the-default-github_token-permissions-to-read-only/ -[github token permissions security]: https://docs.github.com/en/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token [github actions runs-on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on [bencher cli github action]: https://github.com/marketplace/actions/bencher-cli [github actions context]: https://docs.github.com/en/actions/learn-github-actions/contexts#github-context diff --git a/services/console/src/chunks/docs-how-to/github-actions/pt/pull-requests-fork-closed.mdx b/services/console/src/chunks/docs-how-to/github-actions/pt/pull-requests-fork-closed.mdx index 020be40f4..bbcd99aff 100644 --- a/services/console/src/chunks/docs-how-to/github-actions/pt/pull-requests-fork-closed.mdx +++ b/services/console/src/chunks/docs-how-to/github-actions/pt/pull-requests-fork-closed.mdx @@ -16,40 +16,28 @@ Esse workflow arquivará o branch do PR do fork usando o comando `bencher archiv (ex: `on: pull_request: types: [closed]`) 3. Crie um `job` do GitHub Actions. (ex: `jobs: archive_pr_branch`) -4. Defina [as permissões para o `GITHUB_TOKEN`][github token permissions] - como `write` para `pull-requests`. - Dependendo das suas configurações do GitHub, isso pode não ser necessário. - Mas para todas as organizações e repositórios pessoais - [criados após 02 de fevereiro de 2023][github token read only], - este é o comportamento padrão. - Veja [a documentação do GitHub][github token permissions security] - para uma visão completa. - (ex: `permissions: pull-requests: write`) -5. Defina o tipo de máquina em que o job será executado. +4. Defina o tipo de máquina em que o job será executado. Veja a [documentação do `runs-on` do GitHub Actions][github actions runs-on] para uma visão completa. (ex: `runs-on: ubuntu-latest`) -6. Faça checkout do código-fonte do branch do PR. +5. Faça checkout do código-fonte do branch do PR. (ex: `uses: actions/checkout@v4`) -7. Instale o Bencher CLI usando [a GitHub Action][bencher cli github action]. +6. Instale o Bencher CLI usando [a GitHub Action][bencher cli github action]. (ex: `uses: bencherdev/bencher@main`) -8. Use o subcomando da CLI `bencher archive` para arquivar o branch do PR. +7. Use o subcomando da CLI `bencher archive` para arquivar o branch do PR. (ex: `bencher archive`) -9. Defina a opção `--project` para o slug do Projeto. +8. Defina a opção `--project` para o slug do Projeto. Veja [a documentação de `--project`][project option] para mais detalhes. (ex: `--project save-walter-white-1234abcd`) -10. Defina a opção `--token` para o segredo **Repository** `BENCHER_API_TOKEN`. +9. Defina a opção `--token` para o segredo **Repository** `BENCHER_API_TOKEN`. Veja [a documentação de `--token`][token option] para mais detalhes. (ex: `--token '${{ secrets.BENCHER_API_TOKEN }}'`) -11. Defina a opção `--branch` para o nome do branch do PR +10. Defina a opção `--branch` para o nome do branch do PR usando [o contexto `github` do GitHub Actions][github actions context]. (ex: `--branch '${{ github.head_ref }}'`) [github actions on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on [github action pull_request]: https://docs.github.com/en/webhooks/webhook-events-and-payloads#pull_request -[github token permissions]: https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs#setting-the-github_token-permissions-for-a-specific-job -[github token read only]: https://github.blog/changelog/2023-02-02-github-actions-updating-the-default-github_token-permissions-to-read-only/ -[github token permissions security]: https://docs.github.com/en/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token [github actions runs-on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on [bencher cli github action]: https://github.com/marketplace/actions/bencher-cli [github actions context]: https://docs.github.com/en/actions/learn-github-actions/contexts#github-context diff --git a/services/console/src/chunks/docs-how-to/github-actions/pull-requests-closed-code.mdx b/services/console/src/chunks/docs-how-to/github-actions/pull-requests-closed-code.mdx index 7c28fcf6e..63b2a8e8f 100644 --- a/services/console/src/chunks/docs-how-to/github-actions/pull-requests-closed-code.mdx +++ b/services/console/src/chunks/docs-how-to/github-actions/pull-requests-closed-code.mdx @@ -8,8 +8,6 @@ jobs: name: Archive closed PR branch with Bencher # DO NOT REMOVE: For handling Fork PRs see Pull Requests from Forks if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository - permissions: - pull-requests: write runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 diff --git a/services/console/src/chunks/docs-how-to/github-actions/pull-requests-fork-closed-code.mdx b/services/console/src/chunks/docs-how-to/github-actions/pull-requests-fork-closed-code.mdx index fc8d19079..85445895e 100644 --- a/services/console/src/chunks/docs-how-to/github-actions/pull-requests-fork-closed-code.mdx +++ b/services/console/src/chunks/docs-how-to/github-actions/pull-requests-fork-closed-code.mdx @@ -6,8 +6,6 @@ on: jobs: archive_fork_pr_branch: name: Archive closed fork PR branch with Bencher - permissions: - pull-requests: write runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 diff --git a/services/console/src/chunks/docs-how-to/github-actions/ru/base-branch.mdx b/services/console/src/chunks/docs-how-to/github-actions/ru/base-branch.mdx index 0077f3f20..c50685b1a 100644 --- a/services/console/src/chunks/docs-how-to/github-actions/ru/base-branch.mdx +++ b/services/console/src/chunks/docs-how-to/github-actions/ru/base-branch.mdx @@ -16,32 +16,35 @@ import BaseBranchCode from "../base-branch-code.mdx"; (например, `on: push: branches: main`) 3. Создайте `job` для GitHub Actions. (например, `jobs: benchmark_base_branch`) -4. Установите тип машины, на которой будет выполняться задание. +4. Установите [разрешения для `GITHUB_TOKEN`][github token permissions] + на `write` для `checks`. + (например: `permissions: checks: write`) +5. Установите тип машины, на которой будет выполняться задание. См. [документацию о `runs-on` для GitHub Actions][github actions runs-on] для получения подробной информации. (например, `runs-on: ubuntu-latest`) -5. Получите исходный код вашей основной ветки. +6. Получите исходный код вашей основной ветки. (например, `uses: actions/checkout@v4`) -6. Установите Bencher CLI, используя [GitHub Action][bencher cli github action]. +7. Установите Bencher CLI, используя [GitHub Action][bencher cli github action]. (например, `uses: bencherdev/bencher@main`) -7. Используйте подкaманды CLI bencher run +8. Используйте подкaманды CLI bencher run для запуска бенчмарков вашей ветки `main`. См. [подкaманды CLI `bencher run`][bencher run] для получения полной информации. (например, `bencher run`) -8. Установите опцию `--project` на шифр проекта. +9. Установите опцию `--project` на шифр проекта. См. [документацию о `--project`][project option] для получения более подробной информации. (например, `--project save-walter-white-1234abcd`) -9. Установите опцию `--token` на секрет **Repositorий** `BENCHER_API_TOKEN`. +10. Установите опцию `--token` на секрет **Repositorий** `BENCHER_API_TOKEN`. См. [документацию о `--token`][token option] для получения более подробной информации. (например, `--token '${{ secrets.BENCHER_API_TOKEN }}'`) -10. Установите опцию `--branch` на имя основной ветки. +11. Установите опцию `--branch` на имя основной ветки. См. [документацию о `--branch`][branch option] для получения полной информации. (например, `--branch main`) -11. Установите опцию `--testbed` на имя Testbed. +12. Установите опцию `--testbed` на имя Testbed. Это, вероятно, должно соответствовать машине, выбранной в `runs-on`. См. [документацию о `--tested`][testbed option] для получения более подробной информации. (например, `--testbed ubuntu-latest`) -12. Установите порог для ветки `main`, тестового стенда `ubuntu-latest` и измерения `latency`: +13. Установите порог для ветки `main`, тестового стенда `ubuntu-latest` и измерения `latency`: 1. Установите опцию `--threshold-measure` на встроенное измерение `latency`, которое создается bencher mock. См. [документацию о `--threshold-measure`][threshold measure option] для получения более подробной информации. (например, `--threshold-measure latency`) @@ -57,25 +60,26 @@ import BaseBranchCode from "../base-branch-code.mdx"; 5. Установите флаг `--thresholds-reset`, чтобы только указанное пороговое значение было активным. См. [документацию о `--thresholds-reset`][thresholds reset] для получения полной информации. (например, `--thresholds-reset`) -13. Установите флаг `--err`, чтобы команда завершалась с ошибкой, если будет сформировано оповещение. +14. Установите флаг `--err`, чтобы команда завершалась с ошибкой, если будет сформировано оповещение. См. [документацию о `--err`][alert err] для получения полной информации. (например, `--err`) -14. Установите опцию `--adapter` на [формат метрик Bencher в формате JSON (`json`)][bmf], который сгенерирован bencher mock. +15. Установите опцию `--adapter` на [формат метрик Bencher в формате JSON (`json`)][bmf], который сгенерирован bencher mock. См. [Адаптеры для бенчмарк-харнесов][adapter json] для получения полной информации. (например, `--adapter json`) -15. Установите опцию `--github-actions` на токен аутентификации API GitHub, чтобы отправить результаты в виде комментария GitHub Checks, используя +16. Установите опцию `--github-actions` на токен аутентификации API GitHub, чтобы отправить результаты в виде комментария GitHub Checks, используя [переменную окружения `GITHUB_TOKEN` для GitHub Actions][github token]. См. [документацию о `--github-actions`][github actions option] для получения более подробной информации. (например, `--github-actions '${{ secrets.GITHUB_TOKEN }}'`) -16. Укажите аргументы для команды бенчмарков. +17. Укажите аргументы для команды бенчмарков. См. [документацию о команде бенчмарков][command argument] для получения полной информации. (например, `bencher mock`) -[github actions on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on -[github actions push]: https://docs.github.com/en/webhooks/webhook-events-and-payloads#push -[github actions runs-on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on +[github actions on]: https://docs.github.com/ru/actions/using-workflows/workflow-syntax-for-github-actions#on +[github actions push]: https://docs.github.com/ru/webhooks/webhook-events-and-payloads#push +[github token permissions]: https://docs.github.com/ru/actions/using-jobs/assigning-permissions-to-jobs#setting-the-github_token-permissions-for-a-specific-job +[github actions runs-on]: https://docs.github.com/ru/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on [bencher cli github action]: https://github.com/marketplace/actions/bencher-cli -[github token]: https://docs.github.com/en/actions/security-guides/automatic-token-authentication +[github token]: https://docs.github.com/ru/actions/security-guides/automatic-token-authentication [statistical continuous benchmarking]: /ru/docs/how-to/track-benchmarks/#statistical-continuous-benchmarking [bencher run]: /ru/docs/explanation/bencher-run/ diff --git a/services/console/src/chunks/docs-how-to/github-actions/ru/pull-requests-closed.mdx b/services/console/src/chunks/docs-how-to/github-actions/ru/pull-requests-closed.mdx index f1ffdbc89..b62941c29 100644 --- a/services/console/src/chunks/docs-how-to/github-actions/ru/pull-requests-closed.mdx +++ b/services/console/src/chunks/docs-how-to/github-actions/ru/pull-requests-closed.mdx @@ -20,41 +20,29 @@ import PullRequestsClosedCode from "../pull-requests-closed-code.mdx"; ⚠️ НЕ УДАЛЯЙТЕ ЭТУ СТРОКУ! Для обработки Fork PRs см. [Запросы на слияние из форков][pull requests from forks] ниже. (например, `if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository`) -5. Установите [разрешения для `GITHUB_TOKEN`][github token permissions] - на `write` для `pull-requests`. - В зависимости от настроек GitHub, это может не требоваться. - Но для всех организаций и персональных репозиториев, - [созданных после 02 февраля 2023][github token read only], - это поведение по умолчанию. - Ознакомьтесь с [документацией GitHub][github token permissions security] - для полного обзора. - (например, `permissions: pull-requests: write`) -6. Установите тип машины, на которой будет выполняться работа. +5. Установите тип машины, на которой будет выполняться работа. Ознакомьтесь с [документацией GitHub Actions по `runs-on`][github actions runs-on] для полного обзора. (например, `runs-on: ubuntu-latest`) -7. Проверяя исходный код ветки PR. +6. Проверяя исходный код ветки PR. (например, `uses: actions/checkout@v4`) -8. Установите Bencher CLI, используя [GitHub Action][bencher cli github action]. +7. Установите Bencher CLI, используя [GitHub Action][bencher cli github action]. (например, `uses: bencherdev/bencher@main`) -9. Используйте подкоманду `bencher archive` CLI, чтобы архивировать ветку PR. +8. Используйте подкоманду `bencher archive` CLI, чтобы архивировать ветку PR. (например, `bencher archive`) -10. Установите опцию `--project` на слаг проекта. +9. Установите опцию `--project` на слаг проекта. Ознакомьтесь с [документами опции `--project`][project option] для более подробной информации. (например, `--project save-walter-white-1234abcd`) -11. Установите опцию `--token` на секрет **Repository** `BENCHER_API_TOKEN`. +10. Установите опцию `--token` на секрет **Repository** `BENCHER_API_TOKEN`. Ознакомьтесь с [документами опции `--token`][token option] для более подробной информации. (например, `--token '${{ secrets.BENCHER_API_TOKEN }}'`) -12. Установите опцию `--branch` на имя ветки PR +11. Установите опцию `--branch` на имя ветки PR используя [контекст `github` GitHub Actions][github actions context]. (например, `--branch '${{ github.head_ref }}'`) [github actions on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on [github action pull_request]: https://docs.github.com/en/webhooks/webhook-events-and-payloads#pull_request -[github token permissions]: https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs#setting-the-github_token-permissions-for-a-specific-job -[github token read only]: https://github.blog/changelog/2023-02-02-github-actions-updating-the-default-github_token-permissions-to-read-only/ -[github token permissions security]: https://docs.github.com/en/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token [github actions runs-on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on [bencher cli github action]: https://github.com/marketplace/actions/bencher-cli [github actions context]: https://docs.github.com/en/actions/learn-github-actions/contexts#github-context diff --git a/services/console/src/chunks/docs-how-to/github-actions/ru/pull-requests-fork-closed.mdx b/services/console/src/chunks/docs-how-to/github-actions/ru/pull-requests-fork-closed.mdx index 9d8604598..496af6c5b 100644 --- a/services/console/src/chunks/docs-how-to/github-actions/ru/pull-requests-fork-closed.mdx +++ b/services/console/src/chunks/docs-how-to/github-actions/ru/pull-requests-fork-closed.mdx @@ -16,40 +16,28 @@ import PullRequestsForkClosedCode from "../pull-requests-fork-closed-code.mdx"; (например, `on: pull_request: types: [closed]`) 3. Создайте `job` для GitHub Actions. (например, `jobs: archive_pr_branch`) -4. Установите [разрешения для `GITHUB_TOKEN`][github token permissions] - на `write` для `pull-requests`. - В зависимости от ваших настроек GitHub, это может быть не обязательным. - Но для всех организаций и личных репозиториев, - [созданных после 02 февраля 2023][github token read only], - это стандартное поведение. - См. [документацию GitHub][github token permissions security] - для полного обзора. - (например, `permissions: pull-requests: write`) -5. Установите тип машины, на которой будет выполняться задание. +4. Установите тип машины, на которой будет выполняться задание. См. [документацию по `runs-on` для GitHub Actions][github actions runs-on] для полного обзора. (например, `runs-on: ubuntu-latest`) -6. Выполните checkout исходного кода ветки PR. +5. Выполните checkout исходного кода ветки PR. (например, `uses: actions/checkout@v4`) -7. Установите Bencher CLI, используя [GitHub Action][bencher cli github action]. +6. Установите Bencher CLI, используя [GitHub Action][bencher cli github action]. (например, `uses: bencherdev/bencher@main`) -8. Используйте подкоманду CLI `bencher archive` для архивирования ветки PR. +7. Используйте подкоманду CLI `bencher archive` для архивирования ветки PR. (например, `bencher archive`) -9. Установите параметр `--project` на слаг проекта. +8. Установите параметр `--project` на слаг проекта. См. [документацию по `--project`][project option] для получения дополнительных сведений. (например, `--project save-walter-white-1234abcd`) -10. Установите параметр `--token` на секрет **Repository** `BENCHER_API_TOKEN`. +9. Установите параметр `--token` на секрет **Repository** `BENCHER_API_TOKEN`. См. [документацию по `--token`][token option] для получения дополнительных сведений. (например, `--token '${{ secrets.BENCHER_API_TOKEN }}'`) -11. Установите параметр `--branch` на имя ветки PR +10. Установите параметр `--branch` на имя ветки PR используя [контекст `github` в GitHub Actions][github actions context]. (например, `--branch '${{ github.head_ref }}'`) [github actions on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on [github action pull_request]: https://docs.github.com/en/webhooks/webhook-events-and-payloads#pull_request -[github token permissions]: https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs#setting-the-github_token-permissions-for-a-specific-job -[github token read only]: https://github.blog/changelog/2023-02-02-github-actions-updating-the-default-github_token-permissions-to-read-only/ -[github token permissions security]: https://docs.github.com/en/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token [github actions runs-on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on [bencher cli github action]: https://github.com/marketplace/actions/bencher-cli [github actions context]: https://docs.github.com/en/actions/learn-github-actions/contexts#github-context diff --git a/services/console/src/chunks/docs-how-to/github-actions/zh/base-branch.mdx b/services/console/src/chunks/docs-how-to/github-actions/zh/base-branch.mdx index bc179ce9f..b62051467 100644 --- a/services/console/src/chunks/docs-how-to/github-actions/zh/base-branch.mdx +++ b/services/console/src/chunks/docs-how-to/github-actions/zh/base-branch.mdx @@ -14,31 +14,33 @@ import BaseBranchCode from "../base-branch-code.mdx"; (例如：`on: push: branches: main`) 3. 创建一个 GitHub Actions `job`。 (例如：`jobs: benchmark_base_branch`) -4. 设置运行该作业的机器类型。 +4. 将[`GITHUB_TOKEN` 的权限][github token permissions]设置为对`checks`具有`write`权限。 + （例如：`permissions: checks: write`） +5. 设置运行该作业的机器类型。 请参阅 [GitHub Actions `runs-on` 文档][github actions runs-on] 以获取完整概述。 (例如：`runs-on: ubuntu-latest`) -5. 检出您的基础分支源代码。 +6. 检出您的基础分支源代码。 (例如：`uses: actions/checkout@v4`) -6. 使用 [GitHub Action][bencher cli github action] 安装 Bencher CLI。 +7. 使用 [GitHub Action][bencher cli github action] 安装 Bencher CLI。 (例如：`uses: bencherdev/bencher@main`) -7. 使用 bencher run CLI 子命令 +8. 使用 bencher run CLI 子命令 来运行您的 `main` 分支基准测试。 请参阅 [ `bencher run` CLI 子命令][bencher run] 以获取完整概述。 (例如：`bencher run`) -8. 将 `--project` 选项设置为项目标识符。 +9. 将 `--project` 选项设置为项目标识符。 请参阅 [ `--project` 文档][project option] 了解更多详情。 (例如：`--project save-walter-white-1234abcd`) -9. 将 `--token` 选项设置为 `BENCHER_API_TOKEN` **存储库**密钥。 +10. 将 `--token` 选项设置为 `BENCHER_API_TOKEN` **存储库**密钥。 请参阅 [ `--token` 文档][token option] 了解更多详情。 (例如：`--token '${{ secrets.BENCHER_API_TOKEN }}'`) -10. 将 `--branch` 选项设置为基础分支名称。 +11. 将 `--branch` 选项设置为基础分支名称。 请参阅 [ `--branch` 文档][branch option] 了解完整概述。 (例如：`--branch main`) -11. 将 `--testbed` 选项设置为测试平台名称。 +12. 将 `--testbed` 选项设置为测试平台名称。 这应与在 `runs-on` 中选择的机器相匹配。 请参阅 [ `--tested` 文档][testbed option] 了解更多详情。 (例如：`--testbed ubuntu-latest`) -12. 为 `main` 分支、`ubuntu-latest` 测试平台和 `latency` 测量设置阈值： +13. 为 `main` 分支、`ubuntu-latest` 测试平台和 `latency` 测量设置阈值： 1. 将 `--threshold-measure` 选项设置为由 bencher mock 生成的内置 `latency` 测量。 请参阅 [ `--threshold-measure` 文档][threshold measure option] 了解更多详情。 (例如：`--threshold-measure latency`) @@ -54,24 +56,25 @@ import BaseBranchCode from "../base-branch-code.mdx"; 5. 设置 `--thresholds-reset` 标志，使得只有指定的阈值是活跃的。 请参阅 [ `--thresholds-reset` 文档][thresholds reset] 了解完整概述。 (例如：`--thresholds-reset`) -13. 设置 `--err` 标志，如果生成警报，则使命令失败。 +14. 设置 `--err` 标志，如果生成警报，则使命令失败。 请参阅 [ `--err` 文档][alert err] 了解完整概述。 (例如：`--err`) -14. 将 `--adapter` 选项设置为 [Bencher Metric Format JSON (`json`)][bmf]，该格式由 bencher mock 生成。 +15. 将 `--adapter` 选项设置为 [Bencher Metric Format JSON (`json`)][bmf]，该格式由 bencher mock 生成。 请参阅 [基准配置适配器][adapter json] 了解完整概述。 (例如：`--adapter json`) -15. 设置 `--github-actions` 选项为 GitHub API 身份验证令牌，以使用 [GitHub Actions `GITHUB_TOKEN` 环境变量][github token] 作为 GitHub Checks 评论发布结果。 +16. 设置 `--github-actions` 选项为 GitHub API 身份验证令牌，以使用 [GitHub Actions `GITHUB_TOKEN` 环境变量][github token] 作为 GitHub Checks 评论发布结果。 请参阅 [ `--github-actions` 文档][github actions option] 了解更多详情。 (例如：`--github-actions '${{ secrets.GITHUB_TOKEN }}'`) -16. 指定基准测试命令参数。 +17. 指定基准测试命令参数。 请参阅 [基准测试命令][command argument] 了解完整概述。 (例如：`bencher mock`) -[github actions on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on -[github actions push]: https://docs.github.com/en/webhooks/webhook-events-and-payloads#push -[github actions runs-on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on +[github actions on]: https://docs.github.com/zh/actions/using-workflows/workflow-syntax-for-github-actions#on +[github actions push]: https://docs.github.com/zh/webhooks/webhook-events-and-payloads#push +[github token permissions]: https://docs.github.com/zh/actions/using-jobs/assigning-permissions-to-jobs#setting-the-github_token-permissions-for-a-specific-job +[github actions runs-on]: https://docs.github.com/zh/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on [bencher cli github action]: https://github.com/marketplace/actions/bencher-cli -[github token]: https://docs.github.com/en/actions/security-guides/automatic-token-authentication +[github token]: https://docs.github.com/zh/actions/security-guides/automatic-token-authentication [statistical continuous benchmarking]: /zh/docs/how-to/track-benchmarks/#statistical-continuous-benchmarking [bencher run]: /zh/docs/explanation/bencher-run/ diff --git a/services/console/src/chunks/docs-how-to/github-actions/zh/pull-requests-closed.mdx b/services/console/src/chunks/docs-how-to/github-actions/zh/pull-requests-closed.mdx index 3d7d1529c..4d66aa89b 100644 --- a/services/console/src/chunks/docs-how-to/github-actions/zh/pull-requests-closed.mdx +++ b/services/console/src/chunks/docs-how-to/github-actions/zh/pull-requests-closed.mdx @@ -19,36 +19,26 @@ import PullRequestsClosedCode from "../pull-requests-closed-code.mdx"; ⚠️ 不要删除这一行！ 处理 Fork PR 请参阅下文的 [Forks 的 Pull Requests][pull requests from forks]。 （例如：`if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository`） -5. 将 [对于 `GITHUB_TOKEN` 的权限][github token permissions] - 设置为 `pull-requests` 的 `write`。 - 根据您的 GitHub 设置，这可能不是必需的。 - 但对于 [2023 年 2 月 2 日后创建][github token read only] 的所有组织和个人仓库， - 这是默认行为。 - 请参阅 [GitHub 文档][github token permissions security] 以获得完整概述。 - （例如：`permissions: pull-requests: write`） -6. 设置作业运行的机器类型。 +5. 设置作业运行的机器类型。 有关完整概述，请参见 [GitHub Actions `runs-on` 文档][github actions runs-on]。 （例如：`runs-on: ubuntu-latest`） -7. 检出 PR 分支的源代码。 +6. 检出 PR 分支的源代码。 （例如：`uses: actions/checkout@v4`） -8. 使用 [GitHub Action][bencher cli github action] 安装 Bencher CLI。 +7. 使用 [GitHub Action][bencher cli github action] 安装 Bencher CLI。 （例如：`uses: bencherdev/bencher@main`） -9. 使用 `bencher archive` CLI 子命令存档 PR 分支。 +8. 使用 `bencher archive` CLI 子命令存档 PR 分支。 （例如：`bencher archive`） -10. 将 `--project` 选项设置为项目标识符。 +9. 将 `--project` 选项设置为项目标识符。 有关更多详细信息，请参阅 [`--project` 文档][project option]。 （例如：`--project save-walter-white-1234abcd`） -11. 将 `--token` 选项设置为 **仓库** 密钥 `BENCHER_API_TOKEN`。 +10. 将 `--token` 选项设置为 **仓库** 密钥 `BENCHER_API_TOKEN`。 有关更多详细信息，请参阅 [`--token` 文档][token option]。 （例如：`--token '${{ secrets.BENCHER_API_TOKEN }}'`） -12. 使用 [GitHub Actions `github` 上下文][github actions context] 将 `--branch` 选项设置为 PR 分支名。 +11. 使用 [GitHub Actions `github` 上下文][github actions context] 将 `--branch` 选项设置为 PR 分支名。 （例如：`--branch '${{ github.head_ref }}'`） [github actions on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on [github action pull_request]: https://docs.github.com/en/webhooks/webhook-events-and-payloads#pull_request -[github token permissions]: https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs#setting-the-github_token-permissions-for-a-specific-job -[github token read only]: https://github.blog/changelog/2023-02-02-github-actions-updating-the-default-github_token-permissions-to-read-only/ -[github token permissions security]: https://docs.github.com/en/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token [github actions runs-on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on [bencher cli github action]: https://github.com/marketplace/actions/bencher-cli [github actions context]: https://docs.github.com/en/actions/learn-github-actions/contexts#github-context diff --git a/services/console/src/chunks/docs-how-to/github-actions/zh/pull-requests-fork-closed.mdx b/services/console/src/chunks/docs-how-to/github-actions/zh/pull-requests-fork-closed.mdx index 2a83c7137..5af739767 100644 --- a/services/console/src/chunks/docs-how-to/github-actions/zh/pull-requests-fork-closed.mdx +++ b/services/console/src/chunks/docs-how-to/github-actions/zh/pull-requests-fork-closed.mdx @@ -13,33 +13,26 @@ import PullRequestsForkClosedCode from "../pull-requests-fork-closed-code.mdx"; （例如：`on: pull_request: types: [closed]`） 3. 创建一个 GitHub Actions `job`。 （例如：`jobs: archive_pr_branch`） -4. 将 [用于 `GITHUB_TOKEN` 的权限][github token permissions] 设置为 `write`，用于 `pull-requests`。 - 根据您的 GitHub 设置，这可能不是必需的。但对于 [2023年2月2日后创建][github token read only] 的所有组织和个人仓库，这是默认行为。 - 查看 [GitHub 文档][github token permissions security] 以获取完整概述。 - （例如：`permissions: pull-requests: write`） -5. 设置作业将在其上运行的机器类型。 +4. 设置作业将在其上运行的机器类型。 查看 [GitHub Actions `runs-on` 文档][github actions runs-on] 以获取完整概述。 （例如：`runs-on: ubuntu-latest`） -6. 检出 PR 分支的源代码。 +5. 检出 PR 分支的源代码。 （例如：`uses: actions/checkout@v4`） -7. 使用 [GitHub Action][bencher cli github action] 安装 Bencher CLI。 +6. 使用 [GitHub Action][bencher cli github action] 安装 Bencher CLI。 （例如：`uses: bencherdev/bencher@main`） -8. 使用 `bencher archive` CLI 子命令来存档 PR 分支。 +7. 使用 `bencher archive` CLI 子命令来存档 PR 分支。 （例如：`bencher archive`） -9. 设置 `--project` 选项为项目的 slug。 +8. 设置 `--project` 选项为项目的 slug。 查看 [关于 `--project` 的文档][project option] 以获取更多详情。 （例如：`--project save-walter-white-1234abcd`） -10. 将 `--token` 选项设置为 `BENCHER_API_TOKEN` **仓库** 机密。 +9. 将 `--token` 选项设置为 `BENCHER_API_TOKEN` **仓库** 机密。 查看 [关于 `--token` 的文档][token option] 以获取更多详情。 （例如：`--token '${{ secrets.BENCHER_API_TOKEN }}'`） -11. 使用 [GitHub Actions `github` 上下文][github actions context] 将 `--branch` 选项设置为 PR 分支名称。 +10. 使用 [GitHub Actions `github` 上下文][github actions context] 将 `--branch` 选项设置为 PR 分支名称。 （例如：`--branch '${{ github.head_ref }}'`） [github actions on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on [github action pull_request]: https://docs.github.com/en/webhooks/webhook-events-and-payloads#pull_request -[github token permissions]: https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs#setting-the-github_token-permissions-for-a-specific-job -[github token read only]: https://github.blog/changelog/2023-02-02-github-actions-updating-the-default-github_token-permissions-to-read-only/ -[github token permissions security]: https://docs.github.com/en/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token [github actions runs-on]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on [bencher cli github action]: https://github.com/marketplace/actions/bencher-cli [github actions context]: https://docs.github.com/en/actions/learn-github-actions/contexts#github-context