diff --git a/.github/workflows/code-changes-comment.yml b/.github/workflows/comment-code-changes.yml similarity index 98% rename from .github/workflows/code-changes-comment.yml rename to .github/workflows/comment-code-changes.yml index 060d4467c9b0..b47fe751f8ff 100644 --- a/.github/workflows/code-changes-comment.yml +++ b/.github/workflows/comment-code-changes.yml @@ -13,7 +13,7 @@ on: # this applies to any non-content files, this workflow will run for all changed files unless it's ONLY these content-related changes paths-ignore: - 'content/**' - - 'data/reusables/**' + - 'data/**' - 'assets/images/**' permissions: diff --git a/.github/workflows/content-changes-table-comment.yml b/.github/workflows/comment-content-changes-table.yml similarity index 98% rename from .github/workflows/content-changes-table-comment.yml rename to .github/workflows/comment-content-changes-table.yml index a9d28f872d30..e558af9c5c24 100644 --- a/.github/workflows/content-changes-table-comment.yml +++ b/.github/workflows/comment-content-changes-table.yml @@ -27,7 +27,7 @@ on: - synchronize paths: - 'content/**' - - 'data/reusables/**' + - 'data/**' - 'assets/images/**' permissions: @@ -102,5 +102,5 @@ jobs: --- Key: **fpt**: Free, Pro, Team; **ghec**: GitHub Enterprise Cloud; **ghes**: GitHub Enterprise Server - _This table is posted from the [${{ github.workflow }}](https://github.com/${{ github.repository }}/blob/${{ github.sha }}/.github/workflows/content-changes-table-comment.yml) workflow._ + _This table is posted from the [${{ github.workflow }}](https://github.com/${{ github.repository }}/blob/${{ github.sha }}/.github/workflows/comment-content-changes-table.yml) workflow._ edit-mode: replace diff --git a/.github/workflows/headless-tests.yml b/.github/workflows/headless-tests.yml index 29ac7cefe85d..4d1ce72a41ed 100644 --- a/.github/workflows/headless-tests.yml +++ b/.github/workflows/headless-tests.yml @@ -51,6 +51,9 @@ jobs: - name: Index fixtures into the local Elasticsearch run: npm run index-test-fixtures + - name: Install headless browser + run: npx playwright install --no-shell + - name: Run Playwright tests env: PLAYWRIGHT_WORKERS: ${{ fromJSON('[1, 4]')[github.repository == 'github/docs-internal'] }} diff --git a/.github/workflows/local-dev.yml b/.github/workflows/local-dev.yml index 360dd408201d..cfbbbe4be500 100644 --- a/.github/workflows/local-dev.yml +++ b/.github/workflows/local-dev.yml @@ -34,6 +34,9 @@ jobs: - name: Disable Next.js telemetry run: npx next telemetry disable + - name: Install headless browser + run: npx playwright install --no-shell + # The Playwright test, with the env vars we set here, takes care of # starting a server and shutting it down when it's done. # That's why it's important this step comes before the `npm start &` diff --git a/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/using-your-github-profile-to-enhance-your-resume.md b/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/using-your-github-profile-to-enhance-your-resume.md index 4b18d3ad628c..ac50ae68e4d3 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/using-your-github-profile-to-enhance-your-resume.md +++ b/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/using-your-github-profile-to-enhance-your-resume.md @@ -24,76 +24,73 @@ Navigate to your [profile settings](https://github.com/settings/profile) to upda ## Step 2: Create a profile README -Compared to your bio, your profile README is flexible and allows for more creativity. You can write more in your profile README to showcase your skills and interests. +Compared to your bio, your profile README is more flexible, allowing for more creativity. You can write more in your profile README to showcase your skills and interests. Things you may want to add to your profile README include: * **An introduction**: Write a brief introduction of yourself and your professional background. -* **Skills and experience**: List your technical skills, including any programming languages, frameworks, and tools you are proficient in. -* **Your professional experience**: Describe where you've worked before and what sort of professional skills you've built. These can even be non-technical skills, such as communication and empathy. +* **Skills**: List your technical skills, including any programming languages, frameworks, and tools you are proficient in. +* **Professional experience**: Describe where you've worked before and what sort of professional skills you've built. These can even be non-technical skills, such as communication and empathy. * **Some of your best projects**: Describe some projects you're proud of. You'll also pin these repositories later, but your README gives you a chance to provide more commentary. * **Achievements or awards**: Show off any of your achievements, including certifications or awards you've received for your work. -For instructions for creating a profile README, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme#adding-a-profile-readme). +To create your profile README, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme#adding-a-profile-readme). > [!NOTE] Updating and customizing your profile README also helps demonstrate fluency using Markdown and HTML, which are useful skills for technical jobs. To show off your skills for potential employers, look for ways to use more advanced Markdown or HTML elements in your profile README. ## Step 3: Showcase your best projects -Pick your favorite 3-5 projects to highlight for your job application. For the best chances at an interview, pick projects that show your diverse skills and are relevant to your specific job search. +Pick 3-5 projects to highlight by "pinning" them on your profile. Repositories you pin will be prominently displayed, allowing you to direct hiring managers' attention to the projects you're most proud of. -These can be projects you created or projects that you contributed to: +For the best chances at an interview, pick projects that show your diverse skills and are relevant to your specific job search. -* Projects you own are fully under your control, so you can prepare the project using the rest of the steps below. -* Open source projects highlight your ability to collaborate with others. - -To take advantage of both, pin some of each to your profile. +If possible, pin some projects you created and some that you contributed to: -Repositories you pin will be prominently displayed on your profile, allowing you to direct hiring managers' attention to the projects you're most proud of. +* Projects you own are fully under your control, so you can improve them using of the steps below. +* Open source projects highlight your ability to collaborate with others. -To get started, click **Customize your pins** in the "Popular repositories" section of your profile. +To pin the repositories, click **Customize your pins** in the "Popular repositories" section of your profile. ## Step 4: Improve your showcased projects Hiring managers usually consider many applicants for each role. Expect that they will only look at your projects for a couple minutes. To give the best impression during this brief time, you should make your projects easy to understand and explore. -Below, you'll find some practical suggestions for preparing your showcase projects, as well as some tips on using {% data variables.product.prodname_copilot_short %} to help. +### Write a helpful README -> [!NOTE] Always verify the answers that {% data variables.product.prodname_copilot_short %} provides. +The README for your project's repository is a perfect space to give a concise project overview. Use [{% data variables.product.prodname_copilot_chat_short %}](https://github.com/copilot) to help write your README, with a prompt like this: -### Update the repository details +>Write a README for my lottery-number-generator repository. -On the main page of the repository, to the right of "About," click {% octicon "gear" aria-label="Edit repository metadata" %}. Here, you can provide information that helps hiring managers quickly understand the project: -* A brief description of your project -* A website where you can see the project in action -* Topic tags that categorize your project +Then, copy the response into a `README.md` file in the root of the repository, editing as needed. Helpful READMEs include: -### Write a helpful README - -The README for your project's repository is a perfect space to give a concise project overview. Helpful project README details include: * A list of key features of the project * Details on how to set up and run the project * An example or demo of the project * Instructions on testing your code -You can use [Copilot Chat](https://github.com/copilot) to help write your README. Use a prompt like this: ->Write a README for my `lottery-number-generator` repository. +### Update the repository details + +On the main page of the repository, to the right of "About," click {% octicon "gear" aria-label="Edit repository metadata" %}. Here, you can provide information that helps hiring managers quickly understand the project: +* A brief description of your project +* A website where you can see the project in action +* Topic tags that categorize your project ### Make the code easy to understand -To give the best impression, you'll want to make sure that hiring managers can understand your project quickly. In general, a few best practices can help give any readers an understanding of your project and how you work with code: +To give the best impression, you'll want to make sure that hiring managers can understand your project quickly. Follow these best practices: -* Maintain a consistent coding style with descriptive file and directory names throughout the project -* Use helpful comments and documentation for any complex or important snippets -* Refine your code according to popular style guides -* Simplify complex functions, break down large classes, and remove redundant code -* Provide tests to validate that your code is working as expected +* Maintain a **consistent coding style** throughout the project +* Use **descriptive** file and directory names +* Use helpful **comments and documentation** for any complex or important snippets +* Refine your code according to popular **style guides** +* **Simplify** complex functions, break down large classes, and remove redundant code +* Provide **tests** to validate that your code is working as expected -It might be easiest to make these changes locally in {% data variables.product.prodname_vscode_shortname %}, using the {% data variables.product.prodname_copilot_extension_vsc %}. For example, when you start typing a line comment, {% data variables.product.prodname_copilot_short %} can automatically suggest the rest of the comment. +It's easiest to make these changes in {% data variables.product.prodname_vscode_shortname %} with {% data variables.product.prodname_copilot_short %}. For example, when you start typing a line comment, {% data variables.product.prodname_copilot_short %} can automatically suggest the rest of the comment. To get started, see [Set up Visual Studio Code with Copilot](https://code.visualstudio.com/docs/copilot/setup-simplified) in the Visual Studio Code documentation. ### Update your project's dependencies -To showcase your understanding of security best practices, ensure your project is using the latest versions of any dependencies. {% data variables.product.prodname_dependabot %} can alert you to security vulnerabilities in your dependencies and generate pull requests that will update your project to the latest version. See [AUTOTITLE](/code-security/getting-started/dependabot-quickstart-guide). +To showcase your understanding of security best practices, ensure your project is using the **latest versions** of any dependencies. You can automate this process with {% data variables.product.prodname_dependabot %}, which generates pull requests that update your project to the latest version. See [AUTOTITLE](/code-security/getting-started/dependabot-quickstart-guide). ## Extra credit: Maintaining your projects diff --git a/content/admin/managing-github-actions-for-your-enterprise/enabling-github-actions-for-github-enterprise-server/managing-self-hosted-runners-for-dependabot-updates.md b/content/admin/managing-github-actions-for-your-enterprise/enabling-github-actions-for-github-enterprise-server/managing-self-hosted-runners-for-dependabot-updates.md index fb160590be46..d87e702bea44 100644 --- a/content/admin/managing-github-actions-for-your-enterprise/enabling-github-actions-for-github-enterprise-server/managing-self-hosted-runners-for-dependabot-updates.md +++ b/content/admin/managing-github-actions-for-your-enterprise/enabling-github-actions-for-github-enterprise-server/managing-self-hosted-runners-for-dependabot-updates.md @@ -31,6 +31,8 @@ Configuring self-hosted runners is only one step in the middle of the process fo {% data reusables.dependabot.dependabot-runners-system-requirements %} +{% data reusables.dependabot.vnet-arc-note %} + ### Network requirements for {% data variables.product.prodname_dependabot %} runners {% data reusables.dependabot.dependabot-runners-network-requirements %} diff --git a/content/code-security/dependabot/working-with-dependabot/about-dependabot-on-github-actions-runners.md b/content/code-security/dependabot/working-with-dependabot/about-dependabot-on-github-actions-runners.md index dc71126c3736..84993847af2b 100644 --- a/content/code-security/dependabot/working-with-dependabot/about-dependabot-on-github-actions-runners.md +++ b/content/code-security/dependabot/working-with-dependabot/about-dependabot-on-github-actions-runners.md @@ -39,6 +39,9 @@ If you are transitioning to using {% data variables.product.prodname_dependabot {% data reusables.dependabot.dependabot-on-actions-enterprise-policy-condition %} +> [!NOTE] +> {% data variables.product.prodname_dependabot %} on {% data variables.product.prodname_actions %} relies on the `ubuntu-latest` label to select the appropriate runner. To ensure {% data variables.product.prodname_dependabot %} runs on {% data variables.product.github %}-hosted runners, you should not use the label `ubuntu-latest` for self-hosted runners. + ## Enabling or disabling {% data variables.product.prodname_dependabot %} on {% data variables.product.github %}-hosted runners This section only applies to standard {% data variables.product.github %}-hosted runners, not larger runners. diff --git a/content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/about-github-copilot-free.md b/content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/about-github-copilot-free.md index 486f463db04b..fab1e4f8d29c 100644 --- a/content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/about-github-copilot-free.md +++ b/content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/about-github-copilot-free.md @@ -22,11 +22,12 @@ topics: {% data variables.product.prodname_copilot_free_short %} includes the following features: -* Code completion in {% data variables.product.prodname_vscode %}, {% data variables.product.prodname_vs %}, JetBrains IDES, Vim/Neovim, Xcode, and Azure Data Studio +* Code completion in {% data variables.product.prodname_vscode %}, {% data variables.product.prodname_vs %}, JetBrains IDEs, Vim/Neovim, Xcode, and Azure Data Studio * {% data variables.product.prodname_copilot_edits_vscode_short %} to make changes across multiple files (**only in {% data variables.product.prodname_vscode %} and {% data variables.product.prodname_vs %}**) -* {% data variables.product.prodname_copilot_chat_short %} in {% data variables.product.prodname_vscode %}, {% data variables.product.prodname_vs %}, JetBrains IDES, and {% data variables.product.prodname_dotcom_the_website %} +* {% data variables.product.prodname_copilot_chat_short %} in {% data variables.product.prodname_vscode %}, {% data variables.product.prodname_vs %}, JetBrains IDEs, and {% data variables.product.prodname_dotcom_the_website %} * Block suggestions matching public code * Access to {% data variables.copilot.copilot_claude_sonnet %} models +* Access to {% data variables.product.prodname_copilot_extensions_short %} in {% data variables.product.prodname_vscode %}, {% data variables.product.prodname_vs %}, JetBrains IDEs, {% data variables.product.prodname_dotcom_the_website %}, and {% data variables.product.prodname_mobile %} ## What are the limitations of {% data variables.product.prodname_copilot_free_short %}? diff --git a/content/github-cli/github-cli/using-github-cli-extensions.md b/content/github-cli/github-cli/using-github-cli-extensions.md index 4fd5a7ef784a..87045ee465b8 100644 --- a/content/github-cli/github-cli/using-github-cli-extensions.md +++ b/content/github-cli/github-cli/using-github-cli-extensions.md @@ -12,7 +12,7 @@ topics: ## About {% data variables.product.prodname_cli %} extensions > [!NOTE] -> Extensions outside of {% data variables.product.product_name %} and {% data variables.product.prodname_cli %} are not certified by {% data variables.product.product_name %} and are governed by separate terms of service, privacy policy, and support documentation. To mitigate risk when using third-party extensions, audit the source code of the extension before installing or updating the extension. +> Extensions outside of {% data variables.product.github %} and {% data variables.product.prodname_cli %} are not certified by {% data variables.product.github %} and are governed by separate terms of service, privacy policy, and support documentation. To mitigate risk when using third-party extensions, audit the source code of the extension before installing or updating the extension. {% data reusables.cli.cli-extensions %} For more information about how to create {% data variables.product.prodname_cli %} extensions, see [AUTOTITLE](/github-cli/github-cli/creating-github-cli-extensions). diff --git a/content/graphql/guides/migrating-graphql-global-node-ids.md b/content/graphql/guides/migrating-graphql-global-node-ids.md index f519baf141b9..22a5b6ea7699 100644 --- a/content/graphql/guides/migrating-graphql-global-node-ids.md +++ b/content/graphql/guides/migrating-graphql-global-node-ids.md @@ -11,7 +11,7 @@ shortTitle: Migrating global node IDs ## Background -The {% data variables.product.product_name %} GraphQL API currently supports two types of global node ID formats. The legacy format will be {% data variables.release-phases.closing_down %} and replaced with a new format. This guide shows you how to migrate to the new format, if necessary. +The {% data variables.product.github %} GraphQL API currently supports two types of global node ID formats. The legacy format will be {% data variables.release-phases.closing_down %} and replaced with a new format. This guide shows you how to migrate to the new format, if necessary. By migrating to the new format, you ensure that the response times of your requests remain consistent and small. You also ensure that your application continues to work once the legacy IDs are {% data variables.release-phases.closing_down %}. diff --git a/content/graphql/overview/rate-limits-and-node-limits-for-the-graphql-api.md b/content/graphql/overview/rate-limits-and-node-limits-for-the-graphql-api.md index 46623ad2b848..7efadfe004b2 100644 --- a/content/graphql/overview/rate-limits-and-node-limits-for-the-graphql-api.md +++ b/content/graphql/overview/rate-limits-and-node-limits-for-the-graphql-api.md @@ -133,7 +133,7 @@ These two examples show how to calculate the total nodes in a call. {% ifversion ghes %} -Rate limits are disabled by default for {% data variables.product.product_name %}. Contact your site administrator to confirm the rate limits for your instance. +Rate limits are disabled by default for {% data variables.product.prodname_ghe_server %}. Contact your site administrator to confirm the rate limits for your instance. If you are a site administrator, you can set rate limits for your instance. For more information, see [AUTOTITLE](/admin/configuration/configuring-user-applications-for-your-enterprise/configuring-rate-limits). diff --git a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards.md b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards.md index 73bec0a091b1..984e356af05c 100644 --- a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards.md +++ b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards.md @@ -1,6 +1,6 @@ --- title: 'About {% data variables.product.prodname_projects_v1 %}' -intro: '{% data variables.product.prodname_projects_v1_caps %} on {% data variables.product.product_name %} help you organize and prioritize your work. {% ifversion projects-v1-can-create %} You can create {% data variables.projects.projects_v1_boards %} for specific feature work, comprehensive roadmaps, or even release checklists. With {% data variables.product.prodname_projects_v1 %}, you have the flexibility to create customized workflows that suit your needs.{% endif %}' +intro: '{% data variables.product.prodname_projects_v1_caps %} on {% data variables.product.github %} help you organize and prioritize your work. {% ifversion projects-v1-can-create %} You can create {% data variables.projects.projects_v1_boards %} for specific feature work, comprehensive roadmaps, or even release checklists. With {% data variables.product.prodname_projects_v1 %}, you have the flexibility to create customized workflows that suit your needs.{% endif %}' redirect_from: - /github/managing-your-work-on-github/managing-project-boards/about-project-boards - /articles/about-projects diff --git a/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board.md b/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board.md index 813f8645e4c7..e7376e60100f 100644 --- a/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board.md +++ b/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board.md @@ -23,7 +23,7 @@ You can add issue or pull request cards to your {% data variables.projects.proje You can put a maximum of 2,500 cards into each project column. If a column has reached the maximum number of cards, no cards can be moved into that column. > [!NOTE] -> You can also add notes to your {% data variables.projects.projects_v1_board %} to serve as task reminders, references to issues and pull requests from any repository on {% data variables.product.product_name %}, or to add related information to your {% data variables.projects.projects_v1_board %}. For more information, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-notes-to-a-project-board). +> You can also add notes to your {% data variables.projects.projects_v1_board %} to serve as task reminders, references to issues and pull requests from any repository on {% data variables.product.github %}, or to add related information to your {% data variables.projects.projects_v1_board %}. For more information, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-notes-to-a-project-board). {% data reusables.project-management.edit-in-project %} diff --git a/content/issues/planning-and-tracking-with-projects/automating-your-project/adding-items-automatically.md b/content/issues/planning-and-tracking-with-projects/automating-your-project/adding-items-automatically.md index 9fb099151eb9..06aa1b6768fb 100644 --- a/content/issues/planning-and-tracking-with-projects/automating-your-project/adding-items-automatically.md +++ b/content/issues/planning-and-tracking-with-projects/automating-your-project/adding-items-automatically.md @@ -28,7 +28,7 @@ The auto-add workflow supports a subset of filters. You can use the following fi | `is` | open, closed, merged, draft, issue, pr | `label` | "label name" | `reason` | completed, reopened, "not planned" -| `assignee` | {% data variables.product.product_name %} username +| `assignee` | {% data variables.product.github %} username | `no` | label, assignee, reason All filters, other than `no`, support negation. For example, you could use `-label:bug` to add issues that do not have the "bug" label. diff --git a/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md b/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md index 75b5674135db..a07e627a1c43 100644 --- a/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md +++ b/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md @@ -554,7 +554,7 @@ The response will contain the node ID of the newly created draft issue. ### Updating a project's settings -The following example will update your project's settings. Replace `PROJECT_ID` with the node ID of your project. Set `public` to `true` to make your project public on {% data variables.product.product_name %}. Modify `readme` to make changes to your project's README. +The following example will update your project's settings. Replace `PROJECT_ID` with the node ID of your project. Set `public` to `true` to make your project public on {% data variables.product.github %}. Modify `readme` to make changes to your project's README. {% curl %} @@ -770,9 +770,9 @@ gh api graphql -f query=' You can use a mutation to create a new project. For more information, see [AUTOTITLE](/graphql/guides/forming-calls-with-graphql#about-mutations). -To create a new project using the API, you'll need to provide a name for the project and the node ID of a {% data variables.product.product_name %} user or organization who will become the project's owner. +To create a new project using the API, you'll need to provide a name for the project and the node ID of a {% data variables.product.github %} user or organization who will become the project's owner. -You can find the node ID of a {% data variables.product.product_name %} user or organization if you know the username. Replace GITHUB_OWNER with the {% data variables.product.product_name %} username of the new project owner. +You can find the node ID of a {% data variables.product.github %} user or organization if you know the username. Replace GITHUB_OWNER with the {% data variables.product.github %} username of the new project owner. {% curl %} @@ -828,4 +828,4 @@ gh api graphql -f query=' ## Using webhooks -You can use webhooks to subscribe to events taking place in your project. For example, when an item is edited, {% data variables.product.product_name %} can send a HTTP POST payload to the webhook's configured URL which can trigger automation on your server. For more information about webhooks, see [AUTOTITLE](/webhooks-and-events/webhooks/about-webhooks). To learn more about the `projects_v2_item` webhook event, see [AUTOTITLE](/webhooks-and-events/webhooks/webhook-events-and-payloads#projects_v2_item). +You can use webhooks to subscribe to events taking place in your project. For example, when an item is edited, {% data variables.product.github %} can send a HTTP POST payload to the webhook's configured URL which can trigger automation on your server. For more information about webhooks, see [AUTOTITLE](/webhooks-and-events/webhooks/about-webhooks). To learn more about the `projects_v2_item` webhook event, see [AUTOTITLE](/webhooks-and-events/webhooks/webhook-events-and-payloads#projects_v2_item). diff --git a/content/issues/planning-and-tracking-with-projects/managing-items-in-your-project/editing-items-in-your-project.md b/content/issues/planning-and-tracking-with-projects/managing-items-in-your-project/editing-items-in-your-project.md index 380ae82d603f..f02f4ef22325 100644 --- a/content/issues/planning-and-tracking-with-projects/managing-items-in-your-project/editing-items-in-your-project.md +++ b/content/issues/planning-and-tracking-with-projects/managing-items-in-your-project/editing-items-in-your-project.md @@ -63,7 +63,7 @@ You can quickly clear the same field for multiple items. ## Undoing bulk changes in a table -When you make a bulk change in the table layout, {% data variables.product.product_name %} will display the option to undo that change. +When you make a bulk change in the table layout, {% data variables.product.github %} will display the option to undo that change. 1. Make a bulk change to your table. 1. When the notice appears in the lower right of your table, click **Undo**. diff --git a/content/issues/planning-and-tracking-with-projects/managing-your-project/adding-your-project-to-a-team.md b/content/issues/planning-and-tracking-with-projects/managing-your-project/adding-your-project-to-a-team.md index a6bbad63d701..c8b111102374 100644 --- a/content/issues/planning-and-tracking-with-projects/managing-your-project/adding-your-project-to-a-team.md +++ b/content/issues/planning-and-tracking-with-projects/managing-your-project/adding-your-project-to-a-team.md @@ -30,7 +30,7 @@ Teams are granted read permissions on any project they are added to. This permis 1. In the search field, start typing the name of the project you want to add and then select the project in the list of matches. > [!NOTE] - > If this change will result in increased project permissions for the team's members, {% data variables.product.product_name %} will prompt you to confirm your choice. + > If this change will result in increased project permissions for the team's members, {% data variables.product.github %} will prompt you to confirm your choice. ## Removing a project from a team diff --git a/content/issues/tracking-your-work-with-issues/using-issues/filtering-and-searching-issues-and-pull-requests.md b/content/issues/tracking-your-work-with-issues/using-issues/filtering-and-searching-issues-and-pull-requests.md index 4bd662fd30b0..4e4316b97dff 100644 --- a/content/issues/tracking-your-work-with-issues/using-issues/filtering-and-searching-issues-and-pull-requests.md +++ b/content/issues/tracking-your-work-with-issues/using-issues/filtering-and-searching-issues-and-pull-requests.md @@ -1,6 +1,6 @@ --- title: Filtering and searching issues and pull requests -intro: 'To find detailed information about a repository on {% data variables.product.product_name %}, you can filter, sort, and search issues and pull requests that are relevant to the repository.' +intro: 'To find detailed information about a repository on {% data variables.product.github %}, you can filter, sort, and search issues and pull requests that are relevant to the repository.' redirect_from: - /github/managing-your-work-on-github/finding-information-in-a-repository/filtering-issues-and-pull-requests-by-assignees - /articles/filtering-issues-and-pull-requests-by-assignees diff --git a/content/issues/tracking-your-work-with-issues/using-issues/viewing-all-of-your-issues-and-pull-requests.md b/content/issues/tracking-your-work-with-issues/using-issues/viewing-all-of-your-issues-and-pull-requests.md index 7fa7ef9edfe2..cbe0efab9fa3 100644 --- a/content/issues/tracking-your-work-with-issues/using-issues/viewing-all-of-your-issues-and-pull-requests.md +++ b/content/issues/tracking-your-work-with-issues/using-issues/viewing-all-of-your-issues-and-pull-requests.md @@ -23,7 +23,7 @@ Your issue and pull request dashboards are available at the top of any page. On {% ifversion global-nav-update %} 1. At the top of any page, click {% octicon "issue-opened" aria-label="Issues" %} to see your issues or {% octicon "git-pull-request" aria-label="Pull requests" %} to see your pull requests. - ![Screenshot of the header of any page on {% data variables.product.product_name %}. The "Pull requests" and "Issues" icons are outlined in dark orange.](/assets/images/help/navigation/issues-and-prs-new-navigation.png) + ![Screenshot of the header of any page on {% data variables.product.github %}. The "Pull requests" and "Issues" icons are outlined in dark orange.](/assets/images/help/navigation/issues-and-prs-new-navigation.png) {% else %} 1. At the top of any page, click **Pull requests** or **Issues**. diff --git a/content/issues/using-labels-and-milestones-to-track-work/managing-labels.md b/content/issues/using-labels-and-milestones-to-track-work/managing-labels.md index b6d75009ceef..e433db90ccac 100644 --- a/content/issues/using-labels-and-milestones-to-track-work/managing-labels.md +++ b/content/issues/using-labels-and-milestones-to-track-work/managing-labels.md @@ -32,11 +32,11 @@ type: how_to --- ## About labels -You can manage your work on {% data variables.product.product_name %} by creating labels to categorize {% ifversion fpt or ghec %}issues, pull requests, and discussions{% else %}issues and pull requests{% endif %}. You can apply labels in the repository the label was created in. Once a label exists, you can use the label on any {% ifversion fpt or ghec %}issue, pull request, or discussion{% else %}issue or pull request{% endif %} within that repository. +You can manage your work on {% data variables.product.github %} by creating labels to categorize {% ifversion fpt or ghec %}issues, pull requests, and discussions{% else %}issues and pull requests{% endif %}. You can apply labels in the repository the label was created in. Once a label exists, you can use the label on any {% ifversion fpt or ghec %}issue, pull request, or discussion{% else %}issue or pull request{% endif %} within that repository. ## About default labels -{% data variables.product.product_name %} provides default labels in every new repository. You can use these default labels to help create a standard workflow in a repository. +{% data variables.product.github %} provides default labels in every new repository. You can use these default labels to help create a standard workflow in a repository. Label | Description --- | --- diff --git a/content/migrations/importing-source-code/using-github-importer/importing-a-repository-with-github-importer.md b/content/migrations/importing-source-code/using-github-importer/importing-a-repository-with-github-importer.md index febaba269540..a783dcfd416a 100644 --- a/content/migrations/importing-source-code/using-github-importer/importing-a-repository-with-github-importer.md +++ b/content/migrations/importing-source-code/using-github-importer/importing-a-repository-with-github-importer.md @@ -17,7 +17,7 @@ shortTitle: Import a repository {% data variables.product.prodname_importer %} imports the source code and commit history of Git repositories hosted on external hosting services. For more information about the capabilities and limitations of {% data variables.product.prodname_importer %}, see [AUTOTITLE](/migrations/importing-source-code/using-github-importer/about-github-importer#capabilities-and-limitations-of-github-importer). -{% data variables.product.product_name %} uses the email address in the commit header to link a commit to a {% data variables.product.prodname_dotcom %} user. To correctly attribute commits in an imported repository, users will need to add the email address associated with their commits to their account on {% data variables.product.prodname_dotcom %}. For more information, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account). +{% data variables.product.github %} uses the email address in the commit header to link a commit to a {% data variables.product.github %} user. To correctly attribute commits in an imported repository, users will need to add the email address associated with their commits to their {% data variables.product.github %} account. For more information, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account). ## Importing a repository with {% data variables.product.prodname_importer %} diff --git a/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/about-source-code-imports-using-the-command-line.md b/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/about-source-code-imports-using-the-command-line.md index 68595644428c..5208d8ceac4f 100644 --- a/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/about-source-code-imports-using-the-command-line.md +++ b/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/about-source-code-imports-using-the-command-line.md @@ -1,6 +1,6 @@ --- title: About source code imports using the command line -intro: 'You can use command line tools to import source code and its revision history to {% data variables.product.product_name %}.' +intro: 'You can use command line tools to import source code and its revision history to {% data variables.product.github %}.' versions: fpt: '*' ghes: '*' @@ -24,7 +24,7 @@ You can use the command line to import source code and, if the code has been tra * To import a Git repository that is stored on a code hosting service{% ifversion fpt or ghec %} that is not accessible from the public internet{% endif %}, see [AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-an-external-git-repository-using-the-command-line). * To import code that is only stored locally, and is either tracked by Git or not tracked by any version control system, see [AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/adding-locally-hosted-code-to-github). -* To import code that is tracked by any version control system other than Git, first convert the repository to Git, then push the Git repository to {% data variables.product.product_name %}. +* To import code that is tracked by any version control system other than Git, first convert the repository to Git, then push the Git repository to {% data variables.product.github %}. {% ifversion fpt or ghec %} * [AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-subversion-repository) * [AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-mercurial-repository) diff --git a/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/adding-locally-hosted-code-to-github.md b/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/adding-locally-hosted-code-to-github.md index 1edcf5b1d635..ea5a1947993d 100644 --- a/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/adding-locally-hosted-code-to-github.md +++ b/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/adding-locally-hosted-code-to-github.md @@ -1,6 +1,6 @@ --- title: Adding locally hosted code to GitHub -intro: 'If your code is stored locally on your computer and is tracked by Git or not tracked by any version control system (VCS), you can import the code to {% data variables.product.product_name %} using {% data variables.product.prodname_cli %} or Git commands.' +intro: 'If your code is stored locally on your computer and is tracked by Git or not tracked by any version control system (VCS), you can import the code to {% data variables.product.github %} using {% data variables.product.prodname_cli %} or Git commands.' redirect_from: - /articles/add-an-existing-project-to-github - /articles/adding-an-existing-project-to-github-using-the-command-line @@ -15,19 +15,19 @@ versions: shortTitle: Local code --- -## About importing source code to {% data variables.product.product_name %} +## About importing source code {% data reusables.repositories.importing-context %} {% data reusables.repositories.sensitive-info-warning %} -### Adding existing source code to {% data variables.product.product_name %} +### Adding existing source code to {% data variables.product.github %} -If you have source code stored locally on your computer that is tracked by Git or not tracked by any version control system (VCS), you can add the code to {% data variables.product.product_name %} by typing commands in a terminal. You can do this by typing Git commands directly. Alternatively, you can use {% data variables.product.prodname_cli %} or {% data variables.product.prodname_desktop %}. +If you have source code stored locally on your computer that is tracked by Git or not tracked by any version control system (VCS), you can add the code to {% data variables.product.github %} by typing commands in a terminal. You can do this by typing Git commands directly. Alternatively, you can use {% data variables.product.prodname_cli %} or {% data variables.product.prodname_desktop %}. #### Using {% data variables.product.prodname_cli %} -{% data variables.product.prodname_cli %} is an open source tool for using {% data variables.product.prodname_dotcom %} from your computer's command line. {% data variables.product.prodname_cli %} can simplify the process of adding an existing project to {% data variables.product.product_name %} using the command line. To learn more about {% data variables.product.prodname_cli %}, see [AUTOTITLE](/github-cli/github-cli/about-github-cli). +{% data variables.product.prodname_cli %} is an open source tool for using {% data variables.product.prodname_dotcom %} from your computer's command line. {% data variables.product.prodname_cli %} can simplify the process of adding an existing project to {% data variables.product.github %} using the command line. To learn more about {% data variables.product.prodname_cli %}, see [AUTOTITLE](/github-cli/github-cli/about-github-cli). #### Using {% data variables.product.prodname_desktop %} @@ -35,7 +35,7 @@ If you're most comfortable with a point-and-click user interface, consider addin ### Converting repositories from other VCS -If your source code is tracked by a different VCS, such as Mercurial, Subversion, or Team Foundation Version Control, you must convert the repository to Git before you can add the project to {% data variables.product.product_name %}. +If your source code is tracked by a different VCS, such as Mercurial, Subversion, or Team Foundation Version Control, you must convert the repository to Git before you can add the project to {% data variables.product.github %}. * [AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-subversion-repository) * [AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-mercurial-repository) @@ -77,7 +77,7 @@ If your locally-hosted code isn't tracked by any VCS, the first step is to initi ## Importing a Git repository with the command line -After you've initialized a Git repository, you can push the repository to {% data variables.product.product_name %}, using either {% data variables.product.prodname_cli %} or Git. +After you've initialized a Git repository, you can push the repository to {% data variables.product.github %}, using either {% data variables.product.prodname_cli %} or Git. * [Adding a local repository to {% data variables.product.prodname_dotcom %} with {% data variables.product.prodname_cli %}](#adding-a-local-repository-to-github-with-github-cli) * [Adding a local repository to {% data variables.product.prodname_dotcom %} using Git](#adding-a-local-repository-to-github-using-git) diff --git a/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-mercurial-repository.md b/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-mercurial-repository.md index 4fa7c784e64a..2c4fb0c28394 100644 --- a/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-mercurial-repository.md +++ b/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-mercurial-repository.md @@ -1,6 +1,6 @@ --- title: Importing a Mercurial repository -intro: 'You can import a repository from Mercurial by converting the repository to Git, then pushing the Git repository to {% data variables.product.product_name %}.' +intro: 'You can import a repository from Mercurial by converting the repository to Git, then pushing the Git repository to {% data variables.product.github %}.' versions: fpt: '*' ghes: '*' diff --git a/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-subversion-repository.md b/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-subversion-repository.md index 5e92cbff0f79..27a00ee47272 100644 --- a/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-subversion-repository.md +++ b/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-subversion-repository.md @@ -1,6 +1,6 @@ --- title: Importing a Subversion repository -intro: 'You can import a repository from Subversion by converting the repository to Git, then pushing the Git repository to {% data variables.product.product_name %}.' +intro: 'You can import a repository from Subversion by converting the repository to Git, then pushing the Git repository to {% data variables.product.github %}.' versions: fpt: '*' ghes: '*' diff --git a/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-team-foundation-version-control-repository.md b/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-team-foundation-version-control-repository.md index 143213a9d7fc..0cc1cf9d5699 100644 --- a/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-team-foundation-version-control-repository.md +++ b/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-team-foundation-version-control-repository.md @@ -1,6 +1,6 @@ --- title: Importing a Team Foundation Version Control repository -intro: 'You can import a repository from Team Foundation Version Control (TFVC) by converting the repository to Git, then pushing the Git repository to {% data variables.product.product_name %}.' +intro: 'You can import a repository from Team Foundation Version Control (TFVC) by converting the repository to Git, then pushing the Git repository to {% data variables.product.github %}.' versions: fpt: '*' ghes: '*' diff --git a/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-an-external-git-repository-using-the-command-line.md b/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-an-external-git-repository-using-the-command-line.md index 3b164cbe3ff0..c8185cd1f77e 100644 --- a/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-an-external-git-repository-using-the-command-line.md +++ b/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-an-external-git-repository-using-the-command-line.md @@ -15,7 +15,7 @@ shortTitle: External Git repo --- Before you start, make sure you know: -* Your {% data variables.product.product_name %} username +* Your {% data variables.product.github %} username * The clone URL for the external repository, such as `https://external-host.com/user/repo.git` or `git://external-host.com/user/repo.git` (perhaps with a `user@` in front of the `external-host.com` domain name) > [!NOTE] @@ -23,10 +23,10 @@ Before you start, make sure you know: > > * An external account named **extuser** > * An external Git host named `https://external-host.com` -> * A {% data variables.product.product_name %} personal account named **ghuser** +> * A {% data variables.product.github %} personal account named **ghuser** > * A repository on {% data variables.location.product_location %} named **repo.git** -1. [Create a new repository on {% data variables.product.product_name %}](/repositories/creating-and-managing-repositories/creating-a-new-repository). You'll import your external Git repository to this new repository. +1. [Create a new repository on {% data variables.product.github %}](/repositories/creating-and-managing-repositories/creating-a-new-repository). You'll import your external Git repository to this new repository. 1. On the command line, make a "bare" clone of the external repository using the external clone URL. This creates a full copy of the data, but without a working directory for editing files, and ensures a clean, fresh export of all the old data. ```shell @@ -34,7 +34,7 @@ Before you start, make sure you know: # Makes a bare clone of the external repository in a local directory ``` -1. Push the locally cloned repository to {% data variables.product.product_name %} using the "mirror" option, which ensures that all references, such as branches and tags, are copied to the imported repository. +1. Push the locally cloned repository to {% data variables.product.github %} using the "mirror" option, which ensures that all references, such as branches and tags, are copied to the imported repository. ```shell $ cd REPO.git diff --git a/content/migrations/using-github-enterprise-importer/migrating-from-azure-devops-to-github-enterprise-cloud/overview-of-a-migration-from-azure-devops-to-github-enterprise-cloud.md b/content/migrations/using-github-enterprise-importer/migrating-from-azure-devops-to-github-enterprise-cloud/overview-of-a-migration-from-azure-devops-to-github-enterprise-cloud.md index 1e88c9ec5cf3..7a3eb588c8b4 100644 --- a/content/migrations/using-github-enterprise-importer/migrating-from-azure-devops-to-github-enterprise-cloud/overview-of-a-migration-from-azure-devops-to-github-enterprise-cloud.md +++ b/content/migrations/using-github-enterprise-importer/migrating-from-azure-devops-to-github-enterprise-cloud/overview-of-a-migration-from-azure-devops-to-github-enterprise-cloud.md @@ -67,17 +67,17 @@ To migrate a repository, you must be an organization owner for the destination o {% data reusables.enterprise-migration-tool.grant-migrator-tasks %} For more information, see [AUTOTITLE](/migrations/using-github-enterprise-importer/migrating-from-azure-devops-to-github-enterprise-cloud/managing-access-for-a-migration-from-azure-devops#about-the-migrator-role). {% data reusables.enterprise-migration-tool.confirm-migrator-has-correct-pats %} For more information, see [AUTOTITLE](/migrations/using-github-enterprise-importer/migrating-from-azure-devops-to-github-enterprise-cloud/managing-access-for-a-migration-from-azure-devops#required-scopes-for-personal-access-tokens). -### What organizational structure do we want in {% data variables.product.prodname_dotcom %}? +### What organizational structure do we want in {% data variables.product.github %}? -Next, plan the organizational structure you'll create in {% data variables.product.prodname_dotcom %}. ADO and {% data variables.product.prodname_dotcom %} have different ways of organizing an enterprise's work. +Next, plan the organizational structure you'll create in {% data variables.product.github %}. ADO and {% data variables.product.github %} have different ways of organizing an enterprise's work. * ADO: Organization > team project > repositories -* {% data variables.product.prodname_dotcom %}: Enterprise > organization > repositories +* {% data variables.product.github %}: Enterprise > organization > repositories > [!NOTE] -> The concept of a team project, which is used to group repositories in ADO, does not exist in {% data variables.product.prodname_dotcom %}. We do not recommend treating organizations in {% data variables.product.product_name %} as the equivalent of team projects in ADO. +> The concept of a team project, which is used to group repositories in ADO, does not exist in {% data variables.product.github %}. We do not recommend treating organizations in {% data variables.product.github %} as the equivalent of team projects in ADO. -After migrating to {% data variables.product.prodname_dotcom %}, you should have only one enterprise account and a small number of organizations owned by that enterprise. Each organization from ADO should correspond to a single organization on {% data variables.product.prodname_dotcom %}. We do not recommend creating an organization on {% data variables.product.prodname_dotcom %} for each team project on ADO. +After migrating to {% data variables.product.github %}, you should have only one enterprise account and a small number of organizations owned by that enterprise. Each organization from ADO should correspond to a single organization on {% data variables.product.github %}. We do not recommend creating an organization on {% data variables.product.github %} for each team project on ADO. This may result in a large list of ungrouped repositories within each organization. However, you can manage access to groups of repositories by creating teams. For more information, see [AUTOTITLE](/organizations/organizing-members-into-teams/about-teams). diff --git a/content/migrations/using-github-enterprise-importer/understanding-github-enterprise-importer/about-github-enterprise-importer.md b/content/migrations/using-github-enterprise-importer/understanding-github-enterprise-importer/about-github-enterprise-importer.md index 51cadfa80957..1d9c4fbd3c84 100644 --- a/content/migrations/using-github-enterprise-importer/understanding-github-enterprise-importer/about-github-enterprise-importer.md +++ b/content/migrations/using-github-enterprise-importer/understanding-github-enterprise-importer/about-github-enterprise-importer.md @@ -31,7 +31,7 @@ You can migrate on a repository-by-repository basis or, if your migration source * **High fidelity migration**, which allows you to migrate a single repository, a series of repositories, or an entire organization. * **Support for custom trial run migrations**, which allow you to run a migration as many times as you desire before running the production migration. * **Clear and unblocking error logging**, so that migrations are allowed to continue with non-critical migration errors, such as not being able to move a single pull request comment. After the migration, you can review a log file that opens automatically. -* **Users retain ownership of their history**, to ensure that their Git history or {% data variables.product.product_name %} metadata is maintained across the migration. +* **Users retain ownership of their history**, to ensure that their Git history or {% data variables.product.github %} metadata is maintained across the migration. {% data reusables.enterprise-migration-tool.tool-options %} diff --git a/package-lock.json b/package-lock.json index 61d7af3c0e79..f8670a83d210 100644 --- a/package-lock.json +++ b/package-lock.json @@ -107,7 +107,7 @@ "@graphql-inspector/core": "^6.1.0", "@graphql-tools/load": "^8.0.0", "@octokit/rest": "21.0.2", - "@playwright/test": "^1.48.1", + "@playwright/test": "^1.50", "@types/accept-language-parser": "1.5.6", "@types/cheerio": "^0.22.35", "@types/connect-datadog": "0.0.10", @@ -2638,13 +2638,13 @@ } }, "node_modules/@playwright/test": { - "version": "1.48.1", - "resolved": "https://registry.npmjs.org/@playwright/test/-/test-1.48.1.tgz", - "integrity": "sha512-s9RtWoxkOLmRJdw3oFvhFbs9OJS0BzrLUc8Hf6l2UdCNd1rqeEyD4BhCJkvzeEoD1FsK4mirsWwGerhVmYKtZg==", + "version": "1.50.0", + "resolved": "https://registry.npmjs.org/@playwright/test/-/test-1.50.0.tgz", + "integrity": "sha512-ZGNXbt+d65EGjBORQHuYKj+XhCewlwpnSd/EDuLPZGSiEWmgOJB5RmMCCYGy5aMfTs9wx61RivfDKi8H/hcMvw==", "devOptional": true, "license": "Apache-2.0", "dependencies": { - "playwright": "1.48.1" + "playwright": "1.50.0" }, "bin": { "playwright": "cli.js" @@ -12171,13 +12171,13 @@ } }, "node_modules/playwright": { - "version": "1.48.1", - "resolved": "https://registry.npmjs.org/playwright/-/playwright-1.48.1.tgz", - "integrity": "sha512-j8CiHW/V6HxmbntOfyB4+T/uk08tBy6ph0MpBXwuoofkSnLmlfdYNNkFTYD6ofzzlSqLA1fwH4vwvVFvJgLN0w==", + "version": "1.50.0", + "resolved": "https://registry.npmjs.org/playwright/-/playwright-1.50.0.tgz", + "integrity": "sha512-+GinGfGTrd2IfX1TA4N2gNmeIksSb+IAe589ZH+FlmpV3MYTx6+buChGIuDLQwrGNCw2lWibqV50fU510N7S+w==", "devOptional": true, "license": "Apache-2.0", "dependencies": { - "playwright-core": "1.48.1" + "playwright-core": "1.50.0" }, "bin": { "playwright": "cli.js" @@ -12190,9 +12190,9 @@ } }, "node_modules/playwright-core": { - "version": "1.48.1", - "resolved": "https://registry.npmjs.org/playwright-core/-/playwright-core-1.48.1.tgz", - "integrity": "sha512-Yw/t4VAFX/bBr1OzwCuOMZkY1Cnb4z/doAFSwf4huqAGWmf9eMNjmK7NiOljCdLmxeRYcGPPmcDgU0zOlzP0YA==", + "version": "1.50.0", + "resolved": "https://registry.npmjs.org/playwright-core/-/playwright-core-1.50.0.tgz", + "integrity": "sha512-CXkSSlr4JaZs2tZHI40DsZUN/NIwgaUPsyLuOAaIZp2CyF2sN5MM5NJsyB188lFSSozFxQ5fPT4qM+f0tH/6wQ==", "devOptional": true, "license": "Apache-2.0", "bin": { diff --git a/package.json b/package.json index c516355f9fe8..be6e6ba2a1fa 100644 --- a/package.json +++ b/package.json @@ -343,7 +343,7 @@ "@graphql-inspector/core": "^6.1.0", "@graphql-tools/load": "^8.0.0", "@octokit/rest": "21.0.2", - "@playwright/test": "^1.48.1", + "@playwright/test": "^1.50", "@types/accept-language-parser": "1.5.6", "@types/cheerio": "^0.22.35", "@types/connect-datadog": "0.0.10", diff --git a/src/fixtures/playwright.config.ts b/src/fixtures/playwright.config.ts index a6f450fc45d0..9ba48a14ccaf 100644 --- a/src/fixtures/playwright.config.ts +++ b/src/fixtures/playwright.config.ts @@ -113,7 +113,7 @@ export default defineConfig({ { name: 'Google Chrome', use: { - channel: 'chrome', + channel: 'chromium', viewport: { width: 1400, height: 720, diff --git a/src/workflows/content-changes-table-comment-cli.ts b/src/workflows/content-changes-table-comment-cli.ts index 2c71c5339d4d..b17604ee4129 100644 --- a/src/workflows/content-changes-table-comment-cli.ts +++ b/src/workflows/content-changes-table-comment-cli.ts @@ -7,7 +7,7 @@ // locally. // This is more convenient and faster than relying on seeing that the // Action produces in a PR. Especially since -// .github/workflows/content-changes-table-comment.yml only runs +// .github/workflows/comment-content-changes-table.yml only runs // on `pull_request_target`. // // To try it you need to generate a local `GITHUB_TOKEN` that has read-access @@ -32,4 +32,4 @@ program const args = program.args const [owner, repo, baseSHA, headSHA] = args -console.log(await main(owner, repo, baseSHA, headSHA)) +console.log(await main(owner, repo, baseSHA, headSHA, { isFork: false })) diff --git a/src/workflows/content-changes-table-comment.ts b/src/workflows/content-changes-table-comment.ts index 28647cb4c382..1b9ced83f200 100755 --- a/src/workflows/content-changes-table-comment.ts +++ b/src/workflows/content-changes-table-comment.ts @@ -29,23 +29,41 @@ const context = github.context // the max size of the comment (in bytes) // the action we use to post the comment caps out at about 144kb -// see docs-engineering#1849 for more info -const MAX_COMMENT_SIZE = 125000 +// see docs-engineering#1849 and peter-evans/create-or-update-comment#271 for more info. +// The max size the action allows is 2^16, but our table calculates near the end +// of its rendering before we add a key, so playing it safe with 2^15. +const MAX_COMMENT_SIZE = 32768 const PROD_URL = 'https://docs.github.com' // When this file is invoked directly from action as opposed to being imported if (import.meta.url.endsWith(process.argv[1])) { - const owner = context.repo.owner - const repo = context.payload.repository!.name + const isFork = context.payload.pull_request!.head.repo.fork + + const headOwner = context.payload.pull_request!.head.repo.owner.login + const headRepo = context.payload.pull_request!.head.repo.name + + const baseOwner = context.payload.pull_request!.base.repo.owner.login + const baseRepo = context.payload.pull_request!.base.repo.name + const baseSHA = process.env.BASE_SHA || context.payload.pull_request!.base.sha const headSHA = process.env.HEAD_SHA || context.payload.pull_request!.head.sha - const markdownTable = await main(owner, repo, baseSHA, headSHA) + const markdownTable = await main(baseOwner, baseRepo, baseSHA, headSHA, { + isFork, + headOwner, + headRepo, + }) core.setOutput('changesTable', markdownTable) } -async function main(owner: string, repo: string, baseSHA: string, headSHA: string) { +async function main( + owner: string, + repo: string, + baseSHA: string, + headSHA: string, + { isFork, headOwner, headRepo }: { isFork: boolean; headOwner?: string; headRepo?: string }, +) { if (!GITHUB_TOKEN) { throw new Error(`GITHUB_TOKEN environment variable not set`) } @@ -61,7 +79,7 @@ async function main(owner: string, repo: string, baseSHA: string, headSHA: strin // we'll attach the branch or sha right after this const searchParams = new URLSearchParams({ - 'review-server-repository': `${owner}/${repo}`, + 'review-server-repository': isFork ? `${headOwner}/${headRepo}` : `${owner}/${repo}`, }) // this token will be available in the internal repo only, skip it for the open source repo @@ -77,6 +95,7 @@ async function main(owner: string, repo: string, baseSHA: string, headSHA: strin const queryParams = `?${searchParams.toString()}` // get the list of file changes from the PR + // this works even if the head commit is from a fork const response = await octokit.rest.repos.compareCommitsWithBasehead({ owner, repo,