diff --git a/content/code-security/how-tos/secure-at-scale/configure-organization-security/establish-complete-coverage/applying-a-custom-security-configuration.md b/content/code-security/how-tos/secure-at-scale/configure-organization-security/establish-complete-coverage/applying-a-custom-security-configuration.md index 3cd5412cd3fd..61e83368aabc 100644 --- a/content/code-security/how-tos/secure-at-scale/configure-organization-security/establish-complete-coverage/applying-a-custom-security-configuration.md +++ b/content/code-security/how-tos/secure-at-scale/configure-organization-security/establish-complete-coverage/applying-a-custom-security-configuration.md @@ -24,6 +24,7 @@ After you create a {% data variables.product.prodname_custom_security_configurat {% data reusables.profile.access_org %} {% data reusables.organizations.org_settings %} {% data reusables.security-configurations.view-configurations-page %} +1. Click the **Repositories** tab. 1. Optionally, in the "Apply configurations" section, filter for specific repositories you would like to apply your {% data variables.product.prodname_custom_security_configuration %} to. To learn how to filter the repository table, see [AUTOTITLE](/code-security/securing-your-organization/managing-the-security-of-your-organization/filtering-repositories-in-your-organization-using-the-repository-table). {% data reusables.security-configurations.select-repos %} 1. Select the **Apply configuration** {% octicon "triangle-down" aria-hidden="true" aria-label="triangle-down" %} dropdown menu, then click **YOUR-CONFIGURATION-NAME**. diff --git a/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-usage-and-access/managing-your-github-advanced-security-license-usage.md b/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-usage-and-access/managing-your-github-advanced-security-license-usage.md index 6c4ad34a8d3a..8520d072639a 100644 --- a/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-usage-and-access/managing-your-github-advanced-security-license-usage.md +++ b/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-usage-and-access/managing-your-github-advanced-security-license-usage.md @@ -25,6 +25,7 @@ Before you can effectively manage your paid use of {% data variables.product.pro {% data reusables.profile.access_org %} {% data reusables.organizations.org_settings %} {% data reusables.security-configurations.view-configurations-page %} +1. Click the **Repositories** tab. 1. In the "Apply configurations" section, your current license usage will be displayed. {% ifversion ghas-products %}This screenshot shows metered usage. If you have bought a volume/subscription license, then the number of licenses available is also reported. ![Screenshot of the "Apply configurations" section. The current license use for the enterprise is outlined in dark orange.](/assets/images/help/security-configurations/current-sp-cs-license-usage.png) diff --git a/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-your-coverage/detaching-repositories-from-their-security-configurations.md b/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-your-coverage/detaching-repositories-from-their-security-configurations.md index 849283ef3d00..aa6d33d3d1cd 100644 --- a/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-your-coverage/detaching-repositories-from-their-security-configurations.md +++ b/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-your-coverage/detaching-repositories-from-their-security-configurations.md @@ -25,6 +25,7 @@ Alternatively, if you want to apply a {% data variables.product.prodname_securit {% data reusables.profile.access_org %} {% data reusables.organizations.org_settings %} {% data reusables.security-configurations.view-configurations-page %} +1. Click the **Repositories** tab. 1. Optionally, in the "Apply configurations" section, filter for specific repositories you would like to detach from their configurations. To learn more, see [AUTOTITLE](/code-security/securing-your-organization/managing-the-security-of-your-organization/filtering-repositories-in-your-organization-using-the-repository-table). {% data reusables.security-configurations.select-repos %} 1. Select the **Apply configuration** {% octicon "triangle-down" aria-hidden="true" aria-label="triangle-down" %} dropdown menu, then click **No configuration**. diff --git a/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-your-coverage/filtering-repositories-in-your-organization-using-the-repository-table.md b/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-your-coverage/filtering-repositories-in-your-organization-using-the-repository-table.md index 3f25b5f883a9..94e0f0c0459a 100644 --- a/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-your-coverage/filtering-repositories-in-your-organization-using-the-repository-table.md +++ b/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-your-coverage/filtering-repositories-in-your-organization-using-the-repository-table.md @@ -21,6 +21,7 @@ You can filter the repository table in your organization to quickly find and man {% data reusables.profile.access_org %} {% data reusables.organizations.org_settings %} {% data reusables.security-configurations.view-configurations-page %} +1. Click the **Repositories** tab. 1. In the "Apply configurations" section, use the **Search repositories** search bar to filter repositories in your organization in one of two ways: * Find repositories by name with free-text search * Select filters from the dropdown menu that appears once you click the search bar @@ -30,6 +31,7 @@ You can filter the repository table in your organization to quickly find and man {% data reusables.profile.access_org %} {% data reusables.organizations.org_settings %} {% data reusables.security-configurations.view-configurations-page %} +1. Click the **Repositories** tab. 1. To open the advanced filter dialog, in the "Apply configurations" section, click **{% octicon "filter" aria-hidden="true" aria-label="filter" %} Filter**. 1. In the "Advanced filters" window, select the **{% octicon "plus" aria-hidden="true" aria-label="plus" %} Add a filter** dropdown menu, then click a filter. 1. To search for repositories matching the selected filter, fill out the available fields for that filter, then click **Apply**. You can repeat this process to add as many filters as you would like to your search. diff --git a/content/code-security/reference/security-at-scale/troubleshoot-security-configurations/finding-repositories-with-attachment-failures.md b/content/code-security/reference/security-at-scale/troubleshoot-security-configurations/finding-repositories-with-attachment-failures.md index 0b6a7435ec26..10a3b05cd5b0 100644 --- a/content/code-security/reference/security-at-scale/troubleshoot-security-configurations/finding-repositories-with-attachment-failures.md +++ b/content/code-security/reference/security-at-scale/troubleshoot-security-configurations/finding-repositories-with-attachment-failures.md @@ -24,13 +24,14 @@ When an attachment failure happens: * Only some of the settings in the security configuration are applied to affected repositories. * Any changes you later make to the security configuration will not be inherited by the affected repositories. -On the security configuration settings page, under "Apply configurations", you will see a banner advising how many repositories in your organization have an attachment failure, and an overview of the reason(s) for the failure. +On the security configuration settings page, in the **Repositories** tab under "Apply configurations", you will see a banner advising how many repositories in your organization have an attachment failure, and an overview of the reason(s) for the failure. Click the link in the banner display, or alternatively, filter the list of repositories by `config-status:failed`, to see the list of affected repositories and to source additional guidance on how to remediate the attachment failure for a specific repository. {% data reusables.profile.access_org %} {% data reusables.organizations.org_settings %} {% data reusables.security-configurations.view-configurations-page %} +1. Click the **Repositories** tab. 1. In the "Apply configurations" section, filter by `config-status:failed`. 1. From the results list, for the repository you're interested in, click **{% octicon "alert" aria-hidden="true" aria-label="alert" %} Failed REASON**. 1. In the dialog box, review the information and follow the remediation guidance. diff --git a/content/code-security/tutorials/trialing-github-advanced-security/enable-security-features-trial.md b/content/code-security/tutorials/trialing-github-advanced-security/enable-security-features-trial.md index 1021dd15f159..10b917a0985a 100644 --- a/content/code-security/tutorials/trialing-github-advanced-security/enable-security-features-trial.md +++ b/content/code-security/tutorials/trialing-github-advanced-security/enable-security-features-trial.md @@ -28,7 +28,6 @@ When you planned your trial, you identified the features that you want to test a {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.advanced-security-tab %} 1. Click **New configuration** to create a new configuration. -1. To configure groups of security features for your repositories, click **Custom configuration**. 1. Give the configuration a meaningful name and description. 1. You will see that most features are already enabled. Review the features that are **Not set** and enable any that you want to trial, for example: "Automatic dependency submission." 1. In the "Policy" area, set the "Use as default for newly created repositories" option as needed to define whether or not to apply the configuration to new repositories created in the enterprise. @@ -64,7 +63,7 @@ You may find it helpful to apply an enterprise security configuration to all rep 1. Click the **Settings** tab to display the organization settings. 1. In the sidebar, click **{% data variables.product.UI_advanced_security %}** and then **Configurations** to display the security configurations page. 1. Optionally, select the **Apply to** dropdown menu and click either **All repositories**, to apply any configuration to all repositories in the organization, or **All repositories without configurations**, to configure just the repositories in the organization without an existing security configuration. -1. Optionally, in the "Apply configurations" section use the "Search repositories" field or **Filter** button to filter repositories. Then select one or more repositories and use the **Apply configuration** button to choose a configuration to apply to those repositories. +1. Optionally, click the **Repositories** tab, then in the "Apply configurations" section, use the "Search repositories" field or **Filter** button to filter repositories. Then select one or more repositories and use the **Apply configuration** button to choose a configuration to apply to those repositories. For more information, see [AUTOTITLE](/code-security/securing-your-organization/enabling-security-features-in-your-organization/applying-a-custom-security-configuration). diff --git a/content/copilot/concepts/agents/github-copilot-app.md b/content/copilot/concepts/agents/github-copilot-app.md new file mode 100644 index 000000000000..0e7d65422124 --- /dev/null +++ b/content/copilot/concepts/agents/github-copilot-app.md @@ -0,0 +1,70 @@ +--- +title: About the GitHub Copilot app +shortTitle: GitHub Copilot app +intro: 'The {% data variables.copilot.github_copilot_app %} is a desktop application for agent-driven development that brings parallel workstreams, {% data variables.product.github %} integration, and PR lifecycle management into one place.' +product: '{% data reusables.gated-features.github-app %}' +versions: + feature: copilot +contentType: concepts +redirect_from: + - /copilot/concepts/agents/github-app +category: + - Learn about Copilot +--- + +> [!NOTE] The {% data variables.copilot.github_copilot_app %} is in {% data variables.release-phases.technical_preview %} and subject to change. +> +> * **{% data variables.copilot.copilot_business_short %} and {% data variables.copilot.copilot_enterprise_short %} users** — Download and install from the [{% data variables.copilot.github_copilot_app %} repository](https://gh.io/github-copilot-app-repo?utm_source=docs-github-copilot-app-overview&utm_medium=docs&utm_campaign=github-copilot-app-tech-preview-2026) if your organization or enterprise has enabled preview features and {% data variables.copilot.copilot_cli_short %}. +> * **{% data variables.copilot.copilot_pro_short %} and {% data variables.copilot.copilot_pro_plus_short %} users** — To request access, [join the waitlist](https://gh.io/github-copilot-app?utm_source=docs-github-copilot-app-overview&utm_medium=docs&utm_campaign=github-copilot-app-tech-preview-2026). + +## Introduction + +The {% data variables.copilot.github_copilot_app %} is a desktop application purpose-built for agent-driven development. It gives you a single place to direct AI agents across parallel workstreams, work with {% data variables.product.github %} issues and pull requests, and manage the full development lifecycle—without context-switching between terminals, IDEs, and browser tabs. + +The app is built on {% data variables.copilot.copilot_cli %} and integrates natively with {% data variables.product.github %}, so your repositories, branches, and CI pipelines work out of the box. It's designed for workflows where you want to run multiple agents in parallel and stay focused on directing work rather than doing it all yourself. + +## Supported operating systems + +The {% data variables.copilot.github_copilot_app %} supports the following operating systems: + +* macOS +* Linux +* Windows + +## Benefits of using the {% data variables.copilot.github_copilot_app %} + +* **Work in parallel.** Run multiple agent sessions at the same time, each on its own branch, so you can make progress on several tasks without waiting for one to finish. +* **Stay in one place.** Triage issues, direct agents, review changes, and land pull requests without switching between your terminal, IDE, and browser. +* **Start fast.** The app connects to {% data variables.product.github %} natively—your repositories, branches, issues and pull requests work out of the box with no additional setup. +* **Stay in control.** Choose how much autonomy to give agents, from fully collaborative to fully autonomous, and adjust the model and reasoning effort for each session. + +## What can I do with the {% data variables.copilot.github_copilot_app %}? + +* **Parallel workspaces.** Run multiple isolated agent sessions simultaneously, each with a dedicated git worktree and branch. +* **Session modes.** Choose how you work with agents: Interactive (collaborative), Plan (agent plans, you approve), or Autopilot (fully autonomous). +* **{% data variables.product.github %} integration.** Browse and find issues, start sessions from them, create and close pull requests, review pull requests, and view CI check results—all within the app. +* **Model choice.** Select from multiple LLMs and adjust reasoning effort per session. +* **Customizations.** Configure MCP servers, skills, extensions, and plugins for each session. +* **Scheduled workflows.** Save recurring agent tasks and run them on a schedule or on demand. +* **Quick chats.** Brainstorm in a conversation mode without creating a dedicated branch or workspace. +* **Search.** Search for issues or pull requests across your repositories directly from the app. + +## {% data variables.copilot.github_copilot_app %} workflow + +A typical workflow in the {% data variables.copilot.github_copilot_app %} looks like this: + +1. Browse issues in a repository and pick one up, or start from a blank workspace. +1. Choose a session mode—Interactive, Plan, or Autopilot—and select a model. +1. Describe the task and let the agent create a branch, write code, and run tests. +1. Review the agent's changes, provide feedback, and iterate. +1. Create a pull request, leave a review, check whether CI passed, and merge the PR—all from within the app. + +You can run several of these workflows in parallel, each in its own workspace, and switch between them as needed. + +## Providing feedback + +The {% data variables.copilot.github_copilot_app %} is in {% data variables.release-phases.public_preview %}. To share feedback, click the **Give feedback** icon in the bottom-left corner of the app. + +## Further reading + +* [AUTOTITLE](/copilot/how-tos/github-copilot-app/getting-started) diff --git a/content/copilot/concepts/agents/index.md b/content/copilot/concepts/agents/index.md index 2e6b1bb06b5e..1ff14e028926 100644 --- a/content/copilot/concepts/agents/index.md +++ b/content/copilot/concepts/agents/index.md @@ -8,6 +8,7 @@ versions: children: - /cloud-agent - /copilot-cli + - /github-copilot-app - /code-review - /copilot-memory - /hooks diff --git a/content/copilot/how-tos/github-copilot-app/agent-sessions.md b/content/copilot/how-tos/github-copilot-app/agent-sessions.md new file mode 100644 index 000000000000..bd054483e2e6 --- /dev/null +++ b/content/copilot/how-tos/github-copilot-app/agent-sessions.md @@ -0,0 +1,51 @@ +--- +title: Working with agent sessions in the GitHub Copilot app +shortTitle: Agent sessions +intro: 'Run multiple isolated agent sessions simultaneously, each with its own branch, and steer them using different session modes, models, and tools.' +allowTitleToDifferFromFilename: true +product: '{% data reusables.gated-features.github-app %}' +versions: + feature: copilot +contentType: how-tos +redirect_from: + - /copilot/how-tos/github-app/agent-sessions +category: + - Author and optimize with Copilot +--- + +> [!NOTE] The {% data variables.copilot.github_copilot_app %} is in {% data variables.release-phases.technical_preview %} and subject to change. +> +> * **{% data variables.copilot.copilot_business_short %} and {% data variables.copilot.copilot_enterprise_short %} users** — Download and install from the [{% data variables.copilot.github_copilot_app %} repository](https://gh.io/github-copilot-app-repo?utm_source=docs-github-copilot-app-agent-sessions&utm_medium=docs&utm_campaign=github-copilot-app-tech-preview-2026) if your organization or enterprise has enabled preview features and {% data variables.copilot.copilot_cli_short %}. +> * **{% data variables.copilot.copilot_pro_short %} and {% data variables.copilot.copilot_pro_plus_short %} users** — To request access, [join the waitlist](https://gh.io/github-copilot-app?utm_source=docs-github-copilot-app-agent-sessions&utm_medium=docs&utm_campaign=github-copilot-app-tech-preview-2026). + +## Starting a session + +Each session in the {% data variables.copilot.github_copilot_app %} runs in its own isolated workspace, so you can run multiple sessions in parallel and make progress on several tasks without conflicts. + +1. In the sidebar under **Sessions**, click **+** to start a new session. +1. Choose a repository—you can use a local folder, choose from {% data variables.product.github %}, or clone from a URL. +1. Choose whether the session should run in a new working tree or in your local repository. +1. Select a session mode, model, and reasoning effort from the dropdowns above the prompt field. +1. Describe the task in the prompt field. You can reference issues with `#`, add files with `@`, or use `/` for commands. + +The agent starts working. Your active sessions appear in the sidebar grouped by repository—click any session to switch to it. + +## Choosing a session mode + +The session mode controls how much autonomy the agent has. You can set the mode from the dropdown above the prompt field and change it at any time. + +* **Interactive**: You and the agent work together. The agent suggests changes and waits for your input before proceeding. +* **Plan**: The agent creates a plan first. You review and approve the plan before the agent executes it. +* **Autopilot**: The agent works fully autonomously—writing code, running tests, and iterating without waiting for input. + +## Choosing a model + +You can select a model and reasoning effort from the dropdowns above the prompt field. Higher reasoning effort gives the agent more time to think through complex problems but may take longer. You can change both settings at any time during a session. + +## Using quick chats + +**Quick chats** in the sidebar opens a conversation mode without creating a dedicated branch or worktree. Use it for brainstorming, asking questions, or exploring ideas before starting a session. Your chat history is saved and listed by conversation name. + +## Keyboard shortcuts + +The {% data variables.copilot.github_copilot_app %} supports keyboard shortcuts to help you navigate sessions, switch between workspaces, and perform common actions. To see available shortcuts, open the app, go to **Help**, then **Keyboard Shortcuts**. diff --git a/content/copilot/how-tos/github-copilot-app/customize-github-copilot-app.md b/content/copilot/how-tos/github-copilot-app/customize-github-copilot-app.md new file mode 100644 index 000000000000..d8cbe3f936dd --- /dev/null +++ b/content/copilot/how-tos/github-copilot-app/customize-github-copilot-app.md @@ -0,0 +1,38 @@ +--- +title: Customizing the GitHub Copilot app +shortTitle: Customize the GitHub Copilot app +intro: 'Customize the {% data variables.copilot.github_copilot_app %} so it works the way you and your team do.' +allowTitleToDifferFromFilename: true +product: '{% data reusables.gated-features.github-app %}' +versions: + feature: copilot +contentType: how-tos +redirect_from: + - /copilot/how-tos/github-app/customize-github-app +category: + - Author and optimize with Copilot + - Configure Copilot +--- + +> [!NOTE] The {% data variables.copilot.github_copilot_app %} is in {% data variables.release-phases.technical_preview %} and subject to change. +> +> * **{% data variables.copilot.copilot_business_short %} and {% data variables.copilot.copilot_enterprise_short %} users** — Download and install from the [{% data variables.copilot.github_copilot_app %} repository](https://gh.io/github-copilot-app-repo?utm_source=docs-customize-github-copilot-app&utm_medium=docs&utm_campaign=github-copilot-app-tech-preview-2026) if your organization or enterprise has enabled preview features and {% data variables.copilot.copilot_cli_short %}. +> * **{% data variables.copilot.copilot_pro_short %} and {% data variables.copilot.copilot_pro_plus_short %} users** — To request access, [join the waitlist](https://gh.io/github-copilot-app?utm_source=docs-customize-github-copilot-app&utm_medium=docs&utm_campaign=github-copilot-app-tech-preview-2026). + +Tailor the {% data variables.copilot.github_copilot_app %} to your workflows so your agents follow your conventions, use your preferred tools, and apply the right expertise to every task. + +## Setting global instructions + +You can set instructions that apply to every session across all projects in the app settings under **General**. + +## Adding agent skills + +Agent skills are folders of instructions, scripts, and resources that {% data variables.product.prodname_copilot_short %} can load when relevant to improve its performance in specialized tasks. Any skills configured for your repositories or {% data variables.product.prodname_copilot_short %} CLI are automatically available in the {% data variables.copilot.github_copilot_app %}. You can also add and manage skills in the app settings under **Skills**. + +For more information about agent skills, see [AUTOTITLE](/copilot/concepts/agents/about-agent-skills). + +## Configuring MCP servers + +MCP servers connect the agent to external tools and data sources. Any MCP servers configured for your repositories or {% data variables.product.prodname_copilot_short %} CLI are automatically available in the {% data variables.copilot.github_copilot_app %}. You can also add and manage additional MCP servers in the app settings under **MCP Servers**. The app includes a catalog of popular servers, or you can add a custom server. + +For more information about MCP, see [AUTOTITLE](/copilot/how-tos/copilot-cli/customize-copilot/add-mcp-servers). diff --git a/content/copilot/how-tos/github-copilot-app/getting-started.md b/content/copilot/how-tos/github-copilot-app/getting-started.md new file mode 100644 index 000000000000..a3129ee63cc2 --- /dev/null +++ b/content/copilot/how-tos/github-copilot-app/getting-started.md @@ -0,0 +1,90 @@ +--- +title: Getting started with the GitHub Copilot app +shortTitle: Quickstart +allowTitleToDifferFromFilename: true +intro: 'Sign in to the {% data variables.copilot.github_copilot_app %}, ask your first question in a quick chat, and then create a full agent session to make changes to your code.' +product: '{% data reusables.gated-features.github-app %}' +versions: + feature: copilot +contentType: how-tos +redirect_from: + - /copilot/how-tos/github-app/getting-started +category: + - Quickstarts + - Author and optimize with Copilot +--- + +> [!NOTE] The {% data variables.copilot.github_copilot_app %} is in {% data variables.release-phases.technical_preview %} and subject to change. +> +> * **{% data variables.copilot.copilot_business_short %} and {% data variables.copilot.copilot_enterprise_short %} users** — Download and install from the [{% data variables.copilot.github_copilot_app %} repository](https://gh.io/github-copilot-app-repo?utm_source=docs-github-copilot-app-getting-started&utm_medium=docs&utm_campaign=github-copilot-app-tech-preview-2026) if your organization or enterprise has enabled preview features and {% data variables.copilot.copilot_cli_short %}. +> * **{% data variables.copilot.copilot_pro_short %} and {% data variables.copilot.copilot_pro_plus_short %} users** — To request access, [join the waitlist](https://gh.io/github-copilot-app?utm_source=docs-github-copilot-app-getting-started&utm_medium=docs&utm_campaign=github-copilot-app-tech-preview-2026). + +## Prerequisites + +* Access to the {% data variables.copilot.github_copilot_app %}. The app is currently in {% data variables.release-phases.technical_preview %}. + * **{% data variables.copilot.copilot_business_short %} or {% data variables.copilot.copilot_enterprise_short %} users**: You have access, as long as your organization or enterprise has enabled preview features and enabled {% data variables.copilot.copilot_cli_short %}. No waitlist is required, so you can download the app directly from the [{% data variables.copilot.github_copilot_app %} repository](https://gh.io/github-copilot-app-repo?utm_source=docs-github-copilot-app&utm_medium=docs&utm_campaign=github-copilot-app-tech-preview-2026). + * **{% data variables.copilot.copilot_pro_short %} or {% data variables.copilot.copilot_pro_plus_short %} users**: You must join the [waitlist](https://gh.io/github-copilot-app?utm_source=docs-github-copilot-app&utm_medium=docs&utm_campaign=github-copilot-app-tech-preview-2026) and be accepted into the preview to get access. Once accepted, you'll receive a link to download the app. +* The {% data variables.copilot.github_copilot_app %} installed on macOS, Windows, or Linux. Once you have access, you can download and install the application from the [{% data variables.copilot.github_copilot_app %} repository](https://gh.io/github-copilot-app-repo?utm_source=docs-github-copilot-app&utm_medium=docs&utm_campaign=github-copilot-app-tech-preview-2026). + +## Opening the {% data variables.copilot.github_copilot_app %} for the first time + +1. Open the {% data variables.copilot.github_copilot_app %}. +1. Click **Sign in to {% data variables.product.github %}** and follow the prompts to authenticate. +1. The app walks you through onboarding. When prompted, select one or more repositories based on your recent {% data variables.product.github %} activity, or choose a sample project. You can also skip this step and add repositories later. +1. Choose a theme, then complete onboarding. + +## Connecting a repository + +To work on code, you need at least one repository connected to the app. If you skipped repository setup during onboarding, or want to add more repositories later: + +1. Click the **+** button in the sidebar next to "Sessions". +1. Under **Add project from**, choose one of the following: + * **Local folder or repository** — Select a folder already on your machine. + * **{% data variables.product.github %} repository** — Browse and clone a repository from {% data variables.product.github %}. + * **Repository URL** — Clone from any Git URL. + +## Orienting yourself + +The sidebar gives you access to the main areas of the app: + +* **Inbox** - Browse and filter issues and pull requests from your repositories, check CI status, and leave reviews. +* **Workflows** — Saved agent tasks that run on a schedule or on demand. +* **Search** — Search across your repositories directly from the app. +* **Sessions** — Active agent sessions, grouped by repository. This also includes **Quick chats**, which are general chat conversations. + +## Starting a quick chat + +The fastest way to try the {% data variables.copilot.github_copilot_app %} is with a quick chat. Quick chats let you ask questions and brainstorm without creating a branch or worktree. + +1. In the sidebar, click **+** next to "Quick chats" to open a new chat. +1. Type a question or prompt—for example, "Give me an overview of the octocat repository." +1. The agent responds in the conversation view. You can continue the conversation, ask follow-up questions, or start a new chat. + +## Creating your first session + +When you are ready to make changes to code, create a session. You can start from an issue or describe a task directly. + +### Starting from an issue + +1. Click **Inbox** in the sidebar. +1. Browse or filter to find an issue, then click it to view its details. +1. Click **Start a session**. The app creates a new session with the issue context already loaded and automatically uses **Plan** mode. +1. The agent proposes a plan. Review the plan, then you can choose to let the agent start working on a pull request or have it propose changes that you can then manually apply. +1. If you've told it to, the agent creates a branch, makes changes, and even creates a pull request that you can then review and iterate on. + +### Starting from a task + +If you do not have an issue to work from, you can describe a task directly. + +1. In the sidebar, click **+** to start a new session and select a repository. +1. Select a session mode from the dropdown above the prompt field—for example, **Interactive** to work collaboratively with the agent. +1. Describe a task—for example, "Fix the failing test in `utils.test.ts`" or "Add input validation to the signup form." +1. The agent will make changes based on your direction. Follow along in the conversation view and provide feedback to steer the agent. + +## Next steps + +Find out more about using the {% data variables.copilot.github_copilot_app %}: + +* [AUTOTITLE](/copilot/how-tos/github-copilot-app/agent-sessions) +* [AUTOTITLE](/copilot/how-tos/github-copilot-app/managing-issues-and-pull-requests) +* [AUTOTITLE](/copilot/how-tos/github-copilot-app/using-scheduled-workflows) diff --git a/content/copilot/how-tos/github-copilot-app/index.md b/content/copilot/how-tos/github-copilot-app/index.md new file mode 100644 index 000000000000..4da1b753a9dd --- /dev/null +++ b/content/copilot/how-tos/github-copilot-app/index.md @@ -0,0 +1,21 @@ +--- +title: '{% data variables.copilot.github_copilot_app %}' +shortTitle: '{% data variables.copilot.github_copilot_app %}' +intro: 'A desktop application for agent-driven development that brings parallel workstreams, {% data variables.product.github %} integration, and PR lifecycle management into one place.' +versions: + feature: copilot +contentType: how-tos +layout: bespoke-landing +heroImage: /assets/images/banner-images/hero-4 +introLinks: + overview: /copilot/concepts/agents/github-copilot-app + quickstart: /copilot/how-tos/github-copilot-app/getting-started +redirect_from: + - /copilot/how-tos/github-app +children: + - /getting-started + - /customize-github-copilot-app + - /agent-sessions + - /managing-issues-and-pull-requests + - /using-scheduled-workflows +--- diff --git a/content/copilot/how-tos/github-copilot-app/managing-issues-and-pull-requests.md b/content/copilot/how-tos/github-copilot-app/managing-issues-and-pull-requests.md new file mode 100644 index 000000000000..a9acddccc51e --- /dev/null +++ b/content/copilot/how-tos/github-copilot-app/managing-issues-and-pull-requests.md @@ -0,0 +1,51 @@ +--- +title: Managing issues and pull requests with the GitHub Copilot app +shortTitle: Managing issues and pull requests +allowTitleToDifferFromFilename: true +intro: 'Pick up an issue, direct an agent to implement changes, and land a pull request—all without leaving the {% data variables.copilot.github_copilot_app %}.' +product: '{% data reusables.gated-features.github-app %}' +versions: + feature: copilot +contentType: how-tos +redirect_from: + - /copilot/how-tos/github-app/managing-issues-and-pull-requests +category: + - Author and optimize with Copilot +--- + +> [!NOTE] The {% data variables.copilot.github_copilot_app %} is in {% data variables.release-phases.technical_preview %} and subject to change. +> +> * **{% data variables.copilot.copilot_business_short %} and {% data variables.copilot.copilot_enterprise_short %} users** — Download and install from the [{% data variables.copilot.github_copilot_app %} repository](https://gh.io/github-copilot-app-repo?utm_source=docs-github-copilot-app-managing-issues-prs&utm_medium=docs&utm_campaign=github-copilot-app-tech-preview-2026) if your organization or enterprise has enabled preview features and {% data variables.copilot.copilot_cli_short %}. +> * **{% data variables.copilot.copilot_pro_short %} and {% data variables.copilot.copilot_pro_plus_short %} users** — To request access, [join the waitlist](https://gh.io/github-copilot-app?utm_source=docs-github-copilot-app-managing-issues-prs&utm_medium=docs&utm_campaign=github-copilot-app-tech-preview-2026). + +## Browsing your inbox + +Click **Inbox** in the sidebar to see your issues and pull requests in one place. The inbox is organized into sections—by default, **All**, **Active**, **Review requests**, and **Done**. You can edit the default sections or add new ones with your own filters. Use the search bar within any section to find items by keyword or qualifiers like `label:bug`. + +## Starting a session from an issue + +1. In the **Inbox**, find the issue you want to work on, then click it to view its details. +1. Click **Start a session**. The app creates a new session with the issue context already loaded and automatically selects **Plan** mode. +1. The agent proposes a plan. Review the plan, then let the agent start working or have it propose changes that you can apply manually. +1. Once you approve, the agent creates a branch, implements the changes, and opens a pull request for you to review. + +## Reviewing a pull request + +1. Click a pull request in the **Inbox** to see its overview—including the summary, CI check results, and review activity. +1. Switch to the **Files changed** tab to review the diff. +1. Click **Create session** to start a session for the pull request. Within the session, you can leave review comments on the diff, or ask the agent to make changes. +1. Once done reviewing in the session, you can go back to the pull request detail view and click **Review** at the top to submit a review. + +You can also open the pull request in your browser or in another IDE directly from the app. + +## Responding to a review + +You can respond to review comments and resolve failing CI checks in the {% data variables.copilot.github_copilot_app %}. + +1. Open a pull request. +1. Scroll down the page to see review comments on your PR. To ask an agent to resolve a comment, click **{% octicon "copilot" aria-label="The Copilot icon" %} Fix**. +1. At the bottom of the page, view the status of CI checks. To ask an agent to fix failing checks, click **{% octicon "copilot" aria-label="The Copilot icon" %} Fix failing checks**. + +## Merging a pull request + +When you want to merge a pull request, you can enable **agent merge** at the top of the app. Agent merge will prompt the workspace's Copilot session to read your pull request, fix what is blocking it, and merge it as soon as {% data variables.product.github %} allows. It runs in the background, survives app restarts, and turns itself off once your pull request is merged. diff --git a/content/copilot/how-tos/github-copilot-app/using-scheduled-workflows.md b/content/copilot/how-tos/github-copilot-app/using-scheduled-workflows.md new file mode 100644 index 000000000000..42bbe6956747 --- /dev/null +++ b/content/copilot/how-tos/github-copilot-app/using-scheduled-workflows.md @@ -0,0 +1,37 @@ +--- +title: Using scheduled workflows in the GitHub Copilot app +shortTitle: Scheduled workflows +intro: 'Automate recurring agent tasks so they run on a schedule or on demand, without manual intervention.' +allowTitleToDifferFromFilename: true +product: '{% data reusables.gated-features.github-app %}' +versions: + feature: copilot +contentType: how-tos +redirect_from: + - /copilot/how-tos/github-app/using-scheduled-workflows +category: + - Author and optimize with Copilot +--- + +> [!NOTE] The {% data variables.copilot.github_copilot_app %} is in {% data variables.release-phases.technical_preview %} and subject to change. +> +> * **{% data variables.copilot.copilot_business_short %} and {% data variables.copilot.copilot_enterprise_short %} users** — Download and install from the [{% data variables.copilot.github_copilot_app %} repository](https://gh.io/github-copilot-app-repo?utm_source=docs-github-copilot-app-scheduled-workflows&utm_medium=docs&utm_campaign=github-copilot-app-tech-preview-2026) if your organization or enterprise has enabled preview features and {% data variables.copilot.copilot_cli_short %}. +> * **{% data variables.copilot.copilot_pro_short %} and {% data variables.copilot.copilot_pro_plus_short %} users** — To request access, [join the waitlist](https://gh.io/github-copilot-app?utm_source=docs-github-copilot-app-scheduled-workflows&utm_medium=docs&utm_campaign=github-copilot-app-tech-preview-2026). + +## About workflows + +Workflows let you save recurring agent tasks and run them on a schedule or on demand. For example, you can create a workflow that triages new issues daily or checks your open pull requests for review status each morning. + +Click **Workflows** in the sidebar to see your saved workflows. Each workflow shows its name, schedule, associated repository, and last run status. + +## Creating a workflow + +1. Click **New workflow** in the top-right corner. +1. Give the workflow a name and write a prompt describing the task. You can type `/` to add skills. +1. Set the interval—either a recurring schedule (for example, daily at 9:00 AM) or manual. +1. Optionally, configure the session mode, project, model, and reasoning effort. +1. Click **Create** to save, or select **Create and run** to save and test the workflow immediately. + +## Running a workflow on demand + +You can trigger any saved workflow manually by clicking the play button on its card on the "Workflows" page, without waiting for its next scheduled run. diff --git a/content/copilot/how-tos/index.md b/content/copilot/how-tos/index.md index c821202df6cc..9f86c7b89c0c 100644 --- a/content/copilot/how-tos/index.md +++ b/content/copilot/how-tos/index.md @@ -10,6 +10,7 @@ children: - /get-code-suggestions - /chat-with-copilot - /copilot-cli + - /github-copilot-app - /copilot-sdk - /use-copilot-agents - /use-ai-models diff --git a/content/copilot/how-tos/manage-and-track-spending/prepare-for-usage-based-billing.md b/content/copilot/how-tos/manage-and-track-spending/prepare-for-usage-based-billing.md index ebcc82e54513..55c95a219a15 100644 --- a/content/copilot/how-tos/manage-and-track-spending/prepare-for-usage-based-billing.md +++ b/content/copilot/how-tos/manage-and-track-spending/prepare-for-usage-based-billing.md @@ -1,48 +1,48 @@ ---- -title: Preparing your organization for usage-based billing -shortTitle: Prepare your organization for usage-based billing -allowTitleToDifferFromFilename: true -intro: 'Review your estimated costs under usage-based billing and take steps to prepare your organization before the transition.' -permissions: Enterprise owners, organization owners, and billing managers -versions: - feature: copilot -product: '{% data variables.copilot.copilot_enterprise_short %} or {% data variables.copilot.copilot_business_short %}' -contentType: how-tos -category: - - Manage Copilot for a team ---- - - - -On June 1, 2026, {% data variables.product.prodname_copilot_short %} is moving to usage-based billing with {% data variables.product.prodname_ai_credits %}. Use the tool below to understand how this change affects your organization and prepare before the transition takes effect. - - - -## Download the usage report - -From the announcement banner on your enterprise home page, billing overview page, or premium request analytics page, click **Preview your usage** to see your options. From the dialog, click **{% octicon "download" aria-hidden="true" %}** to request a detailed usage report. You can also request the report from the premium request analytics page or via the API. The report is generated asynchronously and delivered via email to the requesting admin. - -The report includes one row per user, per model, per day. Alongside the existing columns for your current billing data, two additional columns show the estimated equivalent under usage-based billing: - -* `aic_quantity`: The number of {% data variables.product.prodname_ai_credits_short %} consumed -* `aic_gross_amount`: The estimated cost in USD under usage-based billing - -## See projected spend - -For a detailed breakdown, you can upload your CSV to the [billing preview tool](https://copilot-billing-preview.github.com/). The tool gives you a view of your estimated costs, including: - -* A side-by-side comparison of your current billing (PRUs) and projected AI Credits (AICs), including total costs with additional usage. -* A detailed breakdown of licenses, consumed units, included discounts, and additional usage for each billing model. - -> [!NOTE] -> The billing preview tool provides estimated projections for illustrative purposes only. Actual usage may differ. Charges are calculated from actual usage emissions processed by the billing platform, separate from the preview data pipeline. - -Your data stays in your browser; nothing is uploaded to a server. - -## Take action before the transition - -Based on what you've learned from the billing preview and usage report, you can take steps to prepare: - -* **Review and adjust your budgets**. Existing enterprise-level budgets for premium requests will automatically carry over to {% data variables.product.prodname_ai_credits_short %}. Review them in your enterprise billing settings to make sure they still reflect the limits you want. -* **Plan for pooled {% data variables.product.prodname_ai_credits_short %}**. Under usage-based billing, each license comes with a monthly amount of included {% data variables.product.prodname_ai_credits_short %}, which are pooled across your organization. Consider how this changes your cost structure. Teams with uneven usage patterns may benefit. -* **Communicate the change internally**. Let your teams know that billing is changing and what it means for their day-to-day use of {% data variables.product.prodname_copilot_short %}. +--- +title: Preparing your organization for usage-based billing +shortTitle: Prepare your organization for usage-based billing +allowTitleToDifferFromFilename: true +intro: 'Review your estimated costs under usage-based billing and take steps to prepare your organization before the transition.' +permissions: Enterprise owners, organization owners, and billing managers +versions: + feature: copilot +product: '{% data variables.copilot.copilot_enterprise_short %} or {% data variables.copilot.copilot_business_short %}' +contentType: how-tos +category: + - Manage Copilot for a team +--- + + + +On June 1, 2026, {% data variables.product.prodname_copilot_short %} is moving to usage-based billing with {% data variables.product.prodname_ai_credits %}. Use the tool below to understand how this change affects your organization and prepare before the transition takes effect. + + + +## Download the usage report + +From the announcement banner on your enterprise home page, billing overview page, or premium request analytics page, click **Preview your usage** to see your options. From the dialog, click **{% octicon "download" aria-hidden="true" %}** to request a detailed usage report. You can also request the report from the premium request analytics page or via the API. The report is generated asynchronously and delivered via email to the requesting admin. + +The report includes one row per user, per model, per day. Alongside the existing columns for your current billing data, two additional columns show the estimated equivalent under usage-based billing: + +* `aic_quantity`: The number of {% data variables.product.prodname_ai_credits_short %} consumed +* `aic_gross_amount`: The estimated cost in USD under usage-based billing + +## See projected spend + +For a detailed breakdown, you can upload your CSV to the [billing preview tool](https://copilot-billing-preview.github.com/). The tool gives you a view of your estimated costs, including: + +* A side-by-side comparison of your current billing (PRUs) and projected AI Credits (AICs), including total costs with additional usage. +* A detailed breakdown of licenses, consumed units, included discounts, and additional usage for each billing model. + +> [!NOTE] +> The billing preview tool provides estimated projections for illustrative purposes only. Actual usage may differ. Charges are calculated from actual usage emissions processed by the billing platform, separate from the preview data pipeline. + +Your data stays in your browser; nothing is uploaded to a server. + +## Take action before the transition + +Based on what you've learned from the billing preview and usage report, you can take steps to prepare: + +* **Review and adjust your budgets**. Existing enterprise-level budgets for premium requests will automatically carry over to {% data variables.product.prodname_ai_credits_short %}. Review them in your enterprise billing settings to make sure they still reflect the limits you want. +* **Plan for pooled {% data variables.product.prodname_ai_credits_short %}**. Under usage-based billing, each license comes with a monthly amount of included {% data variables.product.prodname_ai_credits_short %}, which are pooled across your organization. Consider how this changes your cost structure. Teams with uneven usage patterns may benefit. +* **Communicate the change internally**. Let your teams know that billing is changing and what it means for their day-to-day use of {% data variables.product.prodname_copilot_short %}. diff --git a/content/copilot/how-tos/manage-and-track-spending/prepare-for-your-move-to-usage-based-billing.md b/content/copilot/how-tos/manage-and-track-spending/prepare-for-your-move-to-usage-based-billing.md index b5c8047b1627..0bbb26952489 100644 --- a/content/copilot/how-tos/manage-and-track-spending/prepare-for-your-move-to-usage-based-billing.md +++ b/content/copilot/how-tos/manage-and-track-spending/prepare-for-your-move-to-usage-based-billing.md @@ -1,49 +1,49 @@ ---- -title: Preparing for your move to usage-based billing -shortTitle: Preparing for usage-based billing -allowTitleToDifferFromFilename: true -intro: 'If you''re on a {% data variables.copilot.copilot_pro_short %} or {% data variables.copilot.copilot_pro_plus_short %} plan, review your estimated costs under usage-based billing and take steps to prepare before the transition.' -versions: - feature: copilot -product: '{% data variables.copilot.copilot_pro_short %} or {% data variables.copilot.copilot_pro_plus_short %}' -contentType: how-tos -category: - - Configure Copilot ---- - - - -On June 1, 2026, {% data variables.product.prodname_copilot_short %} is moving to usage-based billing with {% data variables.product.prodname_ai_credits %}. Use the tool below to understand how this change affects you before the transition takes effect. - - - -## Download the usage report - -From the announcement banner on the premium request analytics page, click **Preview your usage** to see your options. From the dialog, click **{% octicon "download" aria-hidden="true" %} Download CSV** to request a detailed usage report. You can also request the report directly from the premium request analytics page, by clicking **Get usage report**. The report is generated asynchronously and delivered to you via email. - -Alongside the existing columns for your current billing data, two additional columns show the estimated equivalent under usage-based billing: - -* `aic_quantity`: The number of {% data variables.product.prodname_ai_credits_short %} consumed -* `aic_gross_amount`: The estimated cost in USD under usage-based billing - -## See projected spend - -For a detailed breakdown, you can upload your CSV to the [billing preview tool](https://copilot-billing-preview.github.com/). The tool gives you a view of your estimated costs, including: - -* A side-by-side comparison of your current billing (PRUs) and projected AI Credits (AICs), including total costs with additional usage. -* A detailed breakdown of consumed units, included discounts, and additional usage for each billing model. - -> [!NOTE] -> The billing preview tool provides estimated projections for illustrative purposes only. Actual usage may differ. Charges are calculated from actual usage emissions processed by the billing platform, separate from the preview data pipeline. - -Your data stays in your browser; nothing is uploaded to a server. - -## Prepare for the transition - -* **Understand what consumes credits**. {% data variables.copilot.copilot_chat_short %}, {% data variables.copilot.copilot_cli_short %}, {% data variables.copilot.copilot_cloud_agent %}, {% data variables.copilot.copilot_spaces %}, {% data variables.product.prodname_spark_short %}, and third-party coding agents consume {% data variables.product.prodname_ai_credits_short %}. Code completions and {% data variables.copilot.next_edit_suggestions %} remain unlimited for all paid plans. -* **Consider your model usage**. Frontier models consume more credits per interaction than lightweight models. Switching to a lighter model for routine tasks can stretch your included usage further. - -## Further reading - -* [AUTOTITLE](/copilot/concepts/billing/usage-based-billing-for-individuals) +--- +title: Preparing for your move to usage-based billing +shortTitle: Preparing for usage-based billing +allowTitleToDifferFromFilename: true +intro: 'If you''re on a {% data variables.copilot.copilot_pro_short %} or {% data variables.copilot.copilot_pro_plus_short %} plan, review your estimated costs under usage-based billing and take steps to prepare before the transition.' +versions: + feature: copilot +product: '{% data variables.copilot.copilot_pro_short %} or {% data variables.copilot.copilot_pro_plus_short %}' +contentType: how-tos +category: + - Configure Copilot +--- + + + +On June 1, 2026, {% data variables.product.prodname_copilot_short %} is moving to usage-based billing with {% data variables.product.prodname_ai_credits %}. Use the tool below to understand how this change affects you before the transition takes effect. + + + +## Download the usage report + +From the announcement banner on the premium request analytics page, click **Preview your usage** to see your options. From the dialog, click **{% octicon "download" aria-hidden="true" %} Download CSV** to request a detailed usage report. You can also request the report directly from the premium request analytics page, by clicking **Get usage report**. The report is generated asynchronously and delivered to you via email. + +Alongside the existing columns for your current billing data, two additional columns show the estimated equivalent under usage-based billing: + +* `aic_quantity`: The number of {% data variables.product.prodname_ai_credits_short %} consumed +* `aic_gross_amount`: The estimated cost in USD under usage-based billing + +## See projected spend + +For a detailed breakdown, you can upload your CSV to the [billing preview tool](https://copilot-billing-preview.github.com/). The tool gives you a view of your estimated costs, including: + +* A side-by-side comparison of your current billing (PRUs) and projected AI Credits (AICs), including total costs with additional usage. +* A detailed breakdown of consumed units, included discounts, and additional usage for each billing model. + +> [!NOTE] +> The billing preview tool provides estimated projections for illustrative purposes only. Actual usage may differ. Charges are calculated from actual usage emissions processed by the billing platform, separate from the preview data pipeline. + +Your data stays in your browser; nothing is uploaded to a server. + +## Prepare for the transition + +* **Understand what consumes credits**. {% data variables.copilot.copilot_chat_short %}, {% data variables.copilot.copilot_cli_short %}, {% data variables.copilot.copilot_cloud_agent %}, {% data variables.copilot.copilot_spaces %}, {% data variables.product.prodname_spark_short %}, and third-party coding agents consume {% data variables.product.prodname_ai_credits_short %}. Code completions and {% data variables.copilot.next_edit_suggestions %} remain unlimited for all paid plans. +* **Consider your model usage**. Frontier models consume more credits per interaction than lightweight models. Switching to a lighter model for routine tasks can stretch your included usage further. + +## Further reading + +* [AUTOTITLE](/copilot/concepts/billing/usage-based-billing-for-individuals) * [AUTOTITLE](/copilot/reference/copilot-billing/models-and-pricing) \ No newline at end of file diff --git a/content/copilot/tutorials/index.md b/content/copilot/tutorials/index.md index c5b83415315d..bd3cd20375b6 100644 --- a/content/copilot/tutorials/index.md +++ b/content/copilot/tutorials/index.md @@ -30,6 +30,7 @@ children: - /vibe-coding - /upgrade-projects - /copilot-cli-hooks + - /use-an-ai-sme redirect_from: - /copilot/using-github-copilot/guides-on-using-github-copilot contentType: tutorials @@ -54,4 +55,3 @@ includedCategories: - Modernize applications - Roll Copilot out at scale --- - diff --git a/content/copilot/tutorials/use-an-ai-sme.md b/content/copilot/tutorials/use-an-ai-sme.md new file mode 100644 index 000000000000..9ab4edb553ed --- /dev/null +++ b/content/copilot/tutorials/use-an-ai-sme.md @@ -0,0 +1,161 @@ +--- +title: Using Copilot CLI as your AI SME +shortTitle: Use an AI SME +intro: 'Use {% data variables.copilot.copilot_cli_short %} as an always-available subject matter expert to learn how a codebase works, so you can confidently maintain it or add new features.' +versions: + feature: copilot +contentType: tutorials +category: + - Scale institutional knowledge + - Author and optimize with Copilot + - Learn about Copilot CLI +allowTitleToDifferFromFilename: true +docsTeamMetrics: + - copilot-cli +--- + +## Introduction + +When you start work on an unfamiliar codebase, or you're asked to change a part of a large codebase that you've never touched before, you usually need a subject matter expert (SME) to bring you up to speed. The SME is typically a more experienced developer on the team who knows how the code fits together and can answer your questions. SMEs are not always available—they may be in another timezone, busy with their own work, or no longer on the team at all. + +When you need to understand an unfamiliar codebase, you usually rely on a teammate who knows the code. When that person isn't available, {% data variables.copilot.copilot_cli_short %} can fill the gap. In this tutorial, you'll ask {% data variables.copilot.copilot_cli_short %} questions about a repository's code, learn prompting techniques that produce code-grounded answers, and build the confidence to start making changes. + +## When to use an AI SME (or even When do I use an AI SME?) + +This tutorial is useful any time you need to understand a codebase faster. For example: + +* You've just joined a team or an open source project and need to get up to speed quickly. +* You need to change an area of a large codebase that you've never worked in before. +* You've inherited a service or library that the original authors no longer maintain. + +The tutorial assumes you're comfortable working in a terminal and reading code in the language used by the project you're exploring. You don't need any prior experience with {% data variables.copilot.copilot_cli_short %}. + +## Prerequisites + +Before you start, make sure you have: + +* A {% data variables.product.prodname_copilot %} subscription. See [AUTOTITLE](/copilot/about-github-copilot/subscription-plans-for-github-copilot). +* {% data variables.copilot.copilot_cli_short %} installed and authenticated. See [AUTOTITLE](/copilot/how-tos/copilot-cli/cli-getting-started). +* A local clone of the repository you want to explore. See [AUTOTITLE](/repositories/creating-and-managing-repositories/cloning-a-repository?tool=webui). + +## 1. Start a session in the repository + +Open a terminal and change into the root of the repository you want to learn about. Starting {% data variables.copilot.copilot_cli_short %} from the repository root means it has the whole codebase available as context. + +```shell copy +cd PATH/TO/YOUR/REPOSITORY +copilot +``` + +You're now in an interactive {% data variables.copilot.copilot_cli_short %} session. Anything you type at the prompt is sent to the model, which can read files in the repository, run shell commands such as `git log` or `grep`, and answer your questions based on what it finds. + +> [!TIP] +> * If you trust {% data variables.copilot.copilot_cli_short %} to run commands without prompting for approval, while blocking file changes, start with `copilot --deny-tool='write' --allow-all-tools`. See [AUTOTITLE](/copilot/how-tos/copilot-cli/use-copilot-cli/allowing-tools). +> * If you're working in a very large codebase, you may get better results by starting {% data variables.copilot.copilot_cli_short %} from the relevant subdirectory. This limits the context to the most relevant files. + +## 2. Ground answers in the code, not the docs + +Most repositories contain a mixture of code and documentation: README files, design notes, architecture diagrams, and so on. Documentation is useful for finding out about a project, but it may be out of date. If you ask {% data variables.copilot.copilot_cli_short %} a question about how the code behaves, and it picks up an answer from an out-of-date Markdown file, you'll get a confident answer that is wrong. + +Before you start asking questions, tell {% data variables.copilot.copilot_cli_short %} to base its answers on the code itself, and to flag any uncertainty rather than fill in gaps. For example: + +```copilot copy +For the rest of this session, when I ask how something works, base your answer on the code in this repository, not on documentation files such as README.md or files under docs/. If a documentation file conflicts with the code, treat the code as the source of truth. If you can't find a definitive answer in the code, say so - don't guess. +``` + +You can put this kind of preamble in a custom instructions file and reuse it across sessions, so you don't have to retype it each time. See [AUTOTITLE](/copilot/how-tos/copilot-cli/customize-copilot/add-custom-instructions). + +## 3. Get an overview of the codebase + +Start with broad questions to build a mental map of the project. The goal is to understand the shape of the code (where the entry points are, which directories contain what, and how the major pieces fit together) before you drill into a specific feature. + +Try prompts such as: + +```copilot copy +Give me an overview of this codebase. What does the application do, what are the main components, and how do they communicate? Cite the files you used as evidence. +``` + +```copilot copy +What are the entry points for this application? For each entry point, tell me which file contains the entry point and which directories contain the code it calls into. +``` + +Asking for citations and evidence is important. When {% data variables.copilot.copilot_cli_short %} tells you "this is handled in `src/auth/middleware.ts`," you can open that file and verify the answer for yourself. If the citation doesn't match what you find, that's a useful signal to push back and ask follow-up questions. + +## 4. Drill into a specific feature + +Once you have an overview, narrow in on the area you need to change. Treat this as a conversation, not a single query. Each answer will surface terms, file names, and concepts that you can use in your next question. + +It's a good idea to ask similar questions that approach a topic from different angles. This helps to ensure you're getting the full picture, and will give you confidence that {% data variables.product.prodname_copilot_short %} hasn't misunderstood what you're trying to find out about, and hasn't missed an important detail. + +For example, suppose you've been asked to add rate limiting to a particular API endpoint, and you've never worked on this part of the code before, you might start with questions such as: + +```copilot copy +Is there any existing rate limiting in this codebase? If so, where is it implemented, and how is it configured? +``` + +```copilot copy +If I wanted to add per-user rate limiting to the /api/v1/upload endpoint, which files would I most likely need to change, and which existing patterns in the codebase should I follow? +``` + +Asking follow-up questions within the same CLI session allows you to drill into the details of a feature and provides {% data variables.product.prodname_copilot_short %} with the context it needs to give you specific answers that tell you what you need to know. + +## 5. Investigate behavior and edge cases + +Reading code tells you what the code does. It often doesn't tell you what the code is supposed to do, or how it behaves in unusual situations. These are the questions where a human SME is most valuable—and where {% data variables.copilot.copilot_cli_short %} can help you when no human is available. + +Some examples of behavior and edge-case questions you might ask: + +```copilot copy +What happens if the database connection drops while a request is being processed? Walk me through the error handling, based on the code. +``` + +```copilot copy +The `getUser` function takes a `userId` parameter. What validation is performed on it before it reaches the database query? Are there any code paths where an unvalidated value could reach the query? +``` + +When you get an answer, follow up with "show me the code" or "which file did you find that in?" if it isn't already cited. This gives you somewhere to check and verify the answer. + +## 6. Use Git history as another source + +A lot of useful context lives in the Git history rather than in the current code: why a function was written the way it was, when a bug was last fixed, who originally added a module. {% data variables.copilot.copilot_cli_short %} can run `git` commands for you and use the output to answer questions you couldn't easily answer by reading the code alone. + +Try prompts such as: + +```copilot copy +When was the `PaymentProcessor` class introduced, and what was the original commit message? Has it been substantially refactored since then? +``` + +```copilot copy +Look at the last 20 commits that touched files under `src/billing/`. Summarize what kinds of changes have been made recently. +``` + +```copilot copy +Who has made the most commits to `src/auth/`? Use that information to suggest the best person on this team to ask about authentication. +``` + +## 7. Verify before you trust + +{% data variables.copilot.copilot_cli_short %} is a powerful SME, but it's not infallible. It can misread code, conflate similar-looking files, or, occasionally, make things up. Treat its answers the way you'd treat advice from a helpful but fallible coworker: useful as a starting point, but worth checking before you act on anything important. + +A few habits will keep you out of trouble: + +* **Check the cited files.** When {% data variables.copilot.copilot_cli_short %} references a specific file or line number, open it and confirm. If the citation is wrong, treat the rest of the answer with more skepticism. +* **Run things yourself.** If {% data variables.copilot.copilot_cli_short %} tells you a function returns `null` for an empty input, write a quick test or REPL invocation that calls it with an empty input and check. +* **Cross-check with humans.** When the answer matters (security, data integrity, anything you'd be embarrassed to get wrong in production), use {% data variables.copilot.copilot_cli_short %}'s answer as a starting point and confirm with a human SME or a code review. + +## Conclusion + +In this tutorial, you've used {% data variables.copilot.copilot_cli_short %} as your personal SME to: + +* Get an overview of an unfamiliar codebase, anchored in real files. +* Drill into a specific feature so you know which files to change and which patterns to follow. +* Investigate behavior, edge cases, and the Git history. +* Verify answers, so you can rely on them when it matters. + +Used this way, {% data variables.copilot.copilot_cli_short %} doesn't replace human SMEs, but it makes you less dependent on them for the day-to-day questions that come up while you work. Your human teammates can focus their time on the questions that genuinely need their experience, and you can keep moving when they're not around. + +## Next steps + +* Save your most useful prompt preambles as custom instructions, so you can reuse them across sessions and projects. See [AUTOTITLE](/copilot/how-tos/copilot-cli/customize-copilot/add-custom-instructions). +* Once you understand the area of the code you want to change, use {% data variables.copilot.copilot_cli_short %} to help you make the change. See [AUTOTITLE](/copilot/tutorials/refactor-code) and [AUTOTITLE](/copilot/tutorials/write-tests). +* Learn how to control which tools {% data variables.copilot.copilot_cli_short %} can run during a session. See [AUTOTITLE](/copilot/how-tos/copilot-cli/use-copilot-cli/allowing-tools). diff --git a/data/reusables/copilot/github-app-preview-note.md b/data/reusables/copilot/github-app-preview-note.md new file mode 100644 index 000000000000..fe9c0e1a5157 --- /dev/null +++ b/data/reusables/copilot/github-app-preview-note.md @@ -0,0 +1,4 @@ +> [!NOTE] The {% data variables.copilot.github_copilot_app %} is in {% data variables.release-phases.technical_preview %} and subject to change. +> +> * **{% data variables.copilot.copilot_business_short %} and {% data variables.copilot.copilot_enterprise_short %} users** — Download and install from the [{% data variables.copilot.github_copilot_app %} repository](https://gh.io/github-copilot-app-repo?utm_source=docs-github-copilot-app&utm_medium=docs&utm_campaign=github-copilot-app-tech-preview-2026) if your organization has enabled preview features and {% data variables.copilot.copilot_cli_short %}. +> * **{% data variables.copilot.copilot_pro_short %} and {% data variables.copilot.copilot_pro_plus_short %} users** — To request access, [join the waitlist](https://gh.io/github-copilot-app?utm_source=docs-github-copilot-app&utm_medium=docs&utm_campaign=github-copilot-app-tech-preview-2026). diff --git a/data/reusables/gated-features/github-app.md b/data/reusables/gated-features/github-app.md new file mode 100644 index 000000000000..0f67615ab65b --- /dev/null +++ b/data/reusables/gated-features/github-app.md @@ -0,0 +1 @@ +{% data variables.copilot.github_copilot_app %} is available with {% data variables.copilot.copilot_for_business %} and {% data variables.copilot.copilot_enterprise %} plans (if the organization has enabled preview features and {% data variables.copilot.copilot_cli_short %}), and via waitlist for {% data variables.copilot.copilot_pro %} and {% data variables.copilot.copilot_pro_plus %} plans. diff --git a/data/variables/copilot.yml b/data/variables/copilot.yml index f9407ace0ce5..17ca01298d68 100644 --- a/data/variables/copilot.yml +++ b/data/variables/copilot.yml @@ -85,6 +85,9 @@ copilot_mobile: 'GitHub Copilot Chat in GitHub Mobile' copilot_vsc_chat_participant: 'Copilot-enabled VS Code chat participant' copilot_vsc_chat_participants: 'Copilot-enabled VS Code chat participants' +## GitHub Copilot app +github_copilot_app: 'GitHub Copilot app' + ## Copilot CLI copilot_cli_short: 'Copilot CLI' copilot_cli: 'GitHub Copilot CLI' diff --git a/src/frame/lib/frontmatter.ts b/src/frame/lib/frontmatter.ts index 682d2d367144..77e83ae7e70e 100644 --- a/src/frame/lib/frontmatter.ts +++ b/src/frame/lib/frontmatter.ts @@ -220,6 +220,12 @@ export const schema: Schema = { translatable: true, description: 'Optional description for the journey track', }, + timeCommitment: { + type: 'string', + translatable: true, + description: + 'Optional time commitment displayed as metadata for the track (e.g. "2-4 hours")', + }, guides: { type: 'array', items: { diff --git a/src/graphql/data/fpt/schema.docs.graphql b/src/graphql/data/fpt/schema.docs.graphql index fb419320748b..e159b7bfa554 100644 --- a/src/graphql/data/fpt/schema.docs.graphql +++ b/src/graphql/data/fpt/schema.docs.graphql @@ -1354,7 +1354,7 @@ type AddedToMergeQueueEvent implements Node { """ Represents a 'added_to_project' event on a given issue or pull request. """ -type AddedToProjectEvent implements Node { +type AddedToProjectEvent implements Node @docsCategory(name: "projects-classic") { """ Identifies the actor who performed the event. """ @@ -1436,7 +1436,7 @@ type AddedToProjectV2Event implements Node & ProjectV2Event { """ Represents configuration for assigning Copilot to an issue (public variant) """ -input AgentAssignmentInput { +input AgentAssignmentInput @docsCategory(name: "users") { """ The base ref/branch for the repository. Defaults to the default branch if not provided. """ @@ -1511,7 +1511,7 @@ type AnnouncementBanner { """ A GitHub App. """ -type App implements Node { +type App implements Node @docsCategory(name: "apps") { """ The client ID of the app. """ @@ -1771,7 +1771,7 @@ type ArchiveRepositoryPayload { """ An object that can have users assigned to it. """ -interface Assignable { +interface Assignable @docsCategory(name: "issues") { """ A list of actors assigned to this object. """ @@ -1892,7 +1892,7 @@ type AssignedEvent implements Node { """ Types that can be assigned to issues. """ -union Assignee = Bot | Mannequin | Organization | User +union Assignee @docsCategory(name: "issues") = Bot | Mannequin | Organization | User """ The connection type for Assignee. @@ -2533,7 +2533,7 @@ type Blob implements GitObject & Node { """ Represents a 'blocked_by_added' event on a given issue. """ -type BlockedByAddedEvent implements Node { +type BlockedByAddedEvent implements Node @docsCategory(name: "issues") { """ Identifies the actor who performed the event. """ @@ -2558,7 +2558,7 @@ type BlockedByAddedEvent implements Node { """ Represents a 'blocked_by_removed' event on a given issue. """ -type BlockedByRemovedEvent implements Node { +type BlockedByRemovedEvent implements Node @docsCategory(name: "issues") { """ Identifies the actor who performed the event. """ @@ -2583,7 +2583,7 @@ type BlockedByRemovedEvent implements Node { """ Represents a 'blocking_added' event on a given issue. """ -type BlockingAddedEvent implements Node { +type BlockingAddedEvent implements Node @docsCategory(name: "issues") { """ Identifies the actor who performed the event. """ @@ -2608,7 +2608,7 @@ type BlockingAddedEvent implements Node { """ Represents a 'blocking_removed' event on a given issue. """ -type BlockingRemovedEvent implements Node { +type BlockingRemovedEvent implements Node @docsCategory(name: "issues") { """ Identifies the actor who performed the event. """ @@ -2633,7 +2633,7 @@ type BlockingRemovedEvent implements Node { """ A special type of user which takes actions on behalf of GitHub Apps. """ -type Bot implements Actor & Node & UniformResourceLocatable { +type Bot implements Actor & Node & UniformResourceLocatable @docsCategory(name: "apps") { """ A URL pointing to the GitHub App's public avatar. """ @@ -4746,7 +4746,7 @@ type CloneTemplateRepositoryPayload { """ An object that can be closed """ -interface Closable { +interface Closable @docsCategory(name: "issues") { """ Indicates if the object is closed (definition of closed may depend on type) """ @@ -5056,7 +5056,7 @@ enum CollaboratorAffiliation { """ Represents a comment. """ -interface Comment { +interface Comment @docsCategory(name: "issues") { """ The actor who authored the comment. """ @@ -5156,7 +5156,7 @@ interface Comment { """ A comment author association with repository. """ -enum CommentAuthorAssociation { +enum CommentAuthorAssociation @docsCategory(name: "issues") { """ Author has been invited to collaborate on the repository. """ @@ -5201,7 +5201,7 @@ enum CommentAuthorAssociation { """ The possible errors that will prevent a user from updating a comment. """ -enum CommentCannotUpdateReason { +enum CommentCannotUpdateReason @docsCategory(name: "issues") { """ Unable to create comment because repository is archived. """ @@ -6519,7 +6519,7 @@ enum ComparisonStatus { """ Represents a 'connected' event on a given issue or pull request. """ -type ConnectedEvent implements Node { +type ConnectedEvent implements Node @docsCategory(name: "issues") { """ Identifies the actor who performed the event. """ @@ -7318,7 +7318,7 @@ type ConvertToDraftEvent implements Node & UniformResourceLocatable { """ Represents a 'converted_from_draft' event on a given issue or pull request. """ -type ConvertedFromDraftEvent implements Node & ProjectV2Event { +type ConvertedFromDraftEvent implements Node & ProjectV2Event @docsCategory(name: "pulls") { """ Identifies the actor who performed the event. """ @@ -11015,7 +11015,7 @@ type DeleteVerifiableDomainPayload { """ Represents a 'demilestoned' event on a given issue or pull request. """ -type DemilestonedEvent implements Node { +type DemilestonedEvent implements Node @docsCategory(name: "issues") { """ Identifies the actor who performed the event. """ @@ -12303,7 +12303,7 @@ type DisablePullRequestAutoMergePayload { """ Represents a 'disconnected' event on a given issue or pull request. """ -type DisconnectedEvent implements Node { +type DisconnectedEvent implements Node @docsCategory(name: "issues") { """ Identifies the actor who performed the event. """ @@ -19146,7 +19146,8 @@ enum IpAllowListUserLevelEnforcementEnabledSettingValue { """ An Issue is a place to discuss ideas, enhancements, tasks, and bugs for a project. """ -type Issue implements Assignable & Closable & Comment & Deletable & Labelable & Lockable & Node & ProjectV2Owner & Reactable & RepositoryNode & Subscribable & SubscribableThread & UniformResourceLocatable & Updatable & UpdatableComment { +type Issue implements Assignable & Closable & Comment & Deletable & Labelable & Lockable & Node & ProjectV2Owner & Reactable & RepositoryNode & Subscribable & SubscribableThread & UniformResourceLocatable & Updatable & UpdatableComment + @docsCategory(name: "issues") { """ Reason that the conversation was locked. """ @@ -20074,7 +20075,7 @@ type Issue implements Assignable & Closable & Comment & Deletable & Labelable & """ The possible state reasons of a closed issue. """ -enum IssueClosedStateReason { +enum IssueClosedStateReason @docsCategory(name: "issues") { """ An issue that has been closed as completed """ @@ -20094,7 +20095,8 @@ enum IssueClosedStateReason { """ Represents a comment on an Issue. """ -type IssueComment implements Comment & Deletable & Minimizable & Node & Pinnable & Reactable & RepositoryNode & Updatable & UpdatableComment { +type IssueComment implements Comment & Deletable & Minimizable & Node & Pinnable & Reactable & RepositoryNode & Updatable & UpdatableComment + @docsCategory(name: "issues") { """ The actor who authored the comment. """ @@ -20378,7 +20380,7 @@ type IssueCommentEdge { """ Ways in which lists of issue comments can be ordered upon return. """ -input IssueCommentOrder { +input IssueCommentOrder @docsCategory(name: "issues") { """ The direction in which to order issue comments by the specified field. """ @@ -20393,7 +20395,7 @@ input IssueCommentOrder { """ Properties by which issue comment connections can be ordered. """ -enum IssueCommentOrderField { +enum IssueCommentOrderField @docsCategory(name: "issues") { """ Order issue comments by update time """ @@ -20403,7 +20405,7 @@ enum IssueCommentOrderField { """ Represents a 'issue_comment_pinned' event on a given issue. """ -type IssueCommentPinnedEvent implements Node { +type IssueCommentPinnedEvent implements Node @docsCategory(name: "issues") { """ Identifies the actor who performed the event. """ @@ -20428,7 +20430,7 @@ type IssueCommentPinnedEvent implements Node { """ Represents a 'issue_comment_unpinned' event on a given issue. """ -type IssueCommentUnpinnedEvent implements Node { +type IssueCommentUnpinnedEvent implements Node @docsCategory(name: "issues") { """ Identifies the actor who performed the event. """ @@ -20478,7 +20480,7 @@ type IssueConnection { """ This aggregates issues opened by a user within one repository. """ -type IssueContributionsByRepository { +type IssueContributionsByRepository @docsCategory(name: "issues") { """ The issue contributions. """ @@ -20518,7 +20520,7 @@ type IssueContributionsByRepository { """ Summary of the state of an issue's dependencies """ -type IssueDependenciesSummary { +type IssueDependenciesSummary @docsCategory(name: "issues") { """ Count of issues this issue is blocked by """ @@ -20543,7 +20545,7 @@ type IssueDependenciesSummary { """ Ordering options issue dependencies """ -input IssueDependencyOrder { +input IssueDependencyOrder @docsCategory(name: "issues") { """ The ordering direction. """ @@ -20558,7 +20560,7 @@ input IssueDependencyOrder { """ Properties by which issue dependencies can be ordered. """ -enum IssueDependencyOrderField { +enum IssueDependencyOrderField @docsCategory(name: "issues") { """ Order issue dependencies by the creation time of the dependent issue """ @@ -20588,7 +20590,7 @@ type IssueEdge { """ Represents a 'issue_field_added' event on a given issue. """ -type IssueFieldAddedEvent implements Node { +type IssueFieldAddedEvent implements Node @docsCategory(name: "issues") { """ Identifies the actor who performed the event. """ @@ -20623,7 +20625,7 @@ type IssueFieldAddedEvent implements Node { """ Represents a 'issue_field_changed' event on a given issue. """ -type IssueFieldChangedEvent implements Node { +type IssueFieldChangedEvent implements Node @docsCategory(name: "issues") { """ Identifies the actor who performed the event. """ @@ -20668,7 +20670,7 @@ type IssueFieldChangedEvent implements Node { """ Common fields across different issue field types """ -interface IssueFieldCommon { +interface IssueFieldCommon @docsCategory(name: "issues") { """ The issue field's creation timestamp. """ @@ -20698,7 +20700,7 @@ interface IssueFieldCommon { """ Represents an issue field value that must be set on an issue during issue creation """ -input IssueFieldCreateOrUpdateInput { +input IssueFieldCreateOrUpdateInput @docsCategory(name: "issues") { """ The date value, for a date field """ @@ -20733,7 +20735,7 @@ input IssueFieldCreateOrUpdateInput { """ The type of an issue field. """ -enum IssueFieldDataType { +enum IssueFieldDataType @docsCategory(name: "issues") { """ Date """ @@ -20758,7 +20760,7 @@ enum IssueFieldDataType { """ Represents a date issue field. """ -type IssueFieldDate implements IssueFieldCommon & Node { +type IssueFieldDate implements IssueFieldCommon & Node @docsCategory(name: "issues") { """ The issue field's creation timestamp. """ @@ -20793,7 +20795,7 @@ type IssueFieldDate implements IssueFieldCommon & Node { """ The value of a date field in an Issue item. """ -type IssueFieldDateValue implements IssueFieldValueCommon & Node { +type IssueFieldDateValue implements IssueFieldValueCommon & Node @docsCategory(name: "issues") { """ The issue field that contains this value. """ @@ -20813,7 +20815,7 @@ type IssueFieldDateValue implements IssueFieldValueCommon & Node { """ Represents a number issue field. """ -type IssueFieldNumber implements IssueFieldCommon & Node { +type IssueFieldNumber implements IssueFieldCommon & Node @docsCategory(name: "issues") { """ The issue field's creation timestamp. """ @@ -20848,7 +20850,7 @@ type IssueFieldNumber implements IssueFieldCommon & Node { """ The value of a number field in an Issue item. """ -type IssueFieldNumberValue implements IssueFieldValueCommon & Node { +type IssueFieldNumberValue implements IssueFieldValueCommon & Node @docsCategory(name: "issues") { """ The issue field that contains this value. """ @@ -20868,7 +20870,7 @@ type IssueFieldNumberValue implements IssueFieldValueCommon & Node { """ Ordering options for issue field connections """ -input IssueFieldOrder { +input IssueFieldOrder @docsCategory(name: "issues") { """ The ordering direction. """ @@ -20883,7 +20885,7 @@ input IssueFieldOrder { """ Properties by which issue field connections can be ordered. """ -enum IssueFieldOrderField { +enum IssueFieldOrderField @docsCategory(name: "issues") { """ Order issue fields by creation time """ @@ -20898,7 +20900,7 @@ enum IssueFieldOrderField { """ Represents a 'issue_field_removed' event on a given issue. """ -type IssueFieldRemovedEvent implements Node { +type IssueFieldRemovedEvent implements Node @docsCategory(name: "issues") { """ Identifies the actor who performed the event. """ @@ -20923,7 +20925,7 @@ type IssueFieldRemovedEvent implements Node { """ Represents a single select issue field. """ -type IssueFieldSingleSelect implements IssueFieldCommon & Node { +type IssueFieldSingleSelect implements IssueFieldCommon & Node @docsCategory(name: "issues") { """ The issue field's creation timestamp. """ @@ -20963,7 +20965,7 @@ type IssueFieldSingleSelect implements IssueFieldCommon & Node { """ Represents an option in a single-select issue field. """ -type IssueFieldSingleSelectOption implements Node { +type IssueFieldSingleSelectOption implements Node @docsCategory(name: "issues") { """ The option's display color. """ @@ -20993,7 +20995,7 @@ type IssueFieldSingleSelectOption implements Node { """ The display color of a single-select field option. """ -enum IssueFieldSingleSelectOptionColor { +enum IssueFieldSingleSelectOptionColor @docsCategory(name: "issues") { """ blue """ @@ -21038,7 +21040,7 @@ enum IssueFieldSingleSelectOptionColor { """ A single selection option for an issue field. """ -input IssueFieldSingleSelectOptionInput { +input IssueFieldSingleSelectOptionInput @docsCategory(name: "issues") { """ The color associated with the option. """ @@ -21063,7 +21065,7 @@ input IssueFieldSingleSelectOptionInput { """ The value of a single select field in an Issue item. """ -type IssueFieldSingleSelectValue implements IssueFieldValueCommon & Node { +type IssueFieldSingleSelectValue implements IssueFieldValueCommon & Node @docsCategory(name: "issues") { """ The option's display color. """ @@ -21103,7 +21105,7 @@ type IssueFieldSingleSelectValue implements IssueFieldValueCommon & Node { """ Represents a text issue field. """ -type IssueFieldText implements IssueFieldCommon & Node { +type IssueFieldText implements IssueFieldCommon & Node @docsCategory(name: "issues") { """ The issue field's creation timestamp. """ @@ -21138,7 +21140,7 @@ type IssueFieldText implements IssueFieldCommon & Node { """ The value of a text field in an Issue item. """ -type IssueFieldTextValue implements IssueFieldValueCommon & Node { +type IssueFieldTextValue implements IssueFieldValueCommon & Node @docsCategory(name: "issues") { """ The issue field that contains this value. """ @@ -21158,12 +21160,16 @@ type IssueFieldTextValue implements IssueFieldValueCommon & Node { """ Issue field values """ -union IssueFieldValue = IssueFieldDateValue | IssueFieldNumberValue | IssueFieldSingleSelectValue | IssueFieldTextValue +union IssueFieldValue @docsCategory(name: "issues") = + | IssueFieldDateValue + | IssueFieldNumberValue + | IssueFieldSingleSelectValue + | IssueFieldTextValue """ Common fields across different issue field value types """ -interface IssueFieldValueCommon { +interface IssueFieldValueCommon @docsCategory(name: "issues") { """ The issue field that contains this value. """ @@ -21213,7 +21219,7 @@ type IssueFieldValueEdge { """ The visibility of an issue field. """ -enum IssueFieldVisibility { +enum IssueFieldVisibility @docsCategory(name: "issues") { """ All """ @@ -21228,7 +21234,11 @@ enum IssueFieldVisibility { """ Possible issue fields. """ -union IssueFields = IssueFieldDate | IssueFieldNumber | IssueFieldSingleSelect | IssueFieldText +union IssueFields @docsCategory(name: "issues") = + | IssueFieldDate + | IssueFieldNumber + | IssueFieldSingleSelect + | IssueFieldText """ The connection type for IssueFields. @@ -21273,7 +21283,7 @@ type IssueFieldsEdge { """ Ways in which to filter lists of issues. """ -input IssueFilters { +input IssueFilters @docsCategory(name: "issues") { """ List issues assigned to given name. Pass in `null` for issues with no assigned user, and `*` for issues assigned to any user. @@ -21333,12 +21343,12 @@ input IssueFilters { """ Used for return value of Repository.issueOrPullRequest. """ -union IssueOrPullRequest = Issue | PullRequest +union IssueOrPullRequest @docsCategory(name: "issues") = Issue | PullRequest """ Ways in which lists of issues can be ordered upon return. """ -input IssueOrder { +input IssueOrder @docsCategory(name: "issues") { """ The direction in which to order issues by the specified field. """ @@ -21353,7 +21363,7 @@ input IssueOrder { """ Properties by which issue connections can be ordered. """ -enum IssueOrderField { +enum IssueOrderField @docsCategory(name: "issues") { """ Order issues by comment count """ @@ -21373,7 +21383,7 @@ enum IssueOrderField { """ Type of issue search performed """ -enum IssueSearchType { +enum IssueSearchType @docsCategory(name: "issues") { """ Hybrid search combining lexical and semantic approaches """ @@ -21393,7 +21403,7 @@ enum IssueSearchType { """ The possible states of an issue. """ -enum IssueState { +enum IssueState @docsCategory(name: "issues") { """ An issue that has been closed """ @@ -21408,7 +21418,7 @@ enum IssueState { """ The possible state reasons of an issue. """ -enum IssueStateReason { +enum IssueStateReason @docsCategory(name: "issues") { """ An issue that has been closed as completed """ @@ -21433,7 +21443,7 @@ enum IssueStateReason { """ A repository issue template. """ -type IssueTemplate { +type IssueTemplate @docsCategory(name: "issues") { """ The template purpose. """ @@ -21548,7 +21558,7 @@ type IssueTimelineConnection { """ An item in an issue timeline """ -union IssueTimelineItem = +union IssueTimelineItem @docsCategory(name: "issues") = | AssignedEvent | ClosedEvent | Commit @@ -21587,7 +21597,7 @@ type IssueTimelineItemEdge { """ An item in an issue timeline """ -union IssueTimelineItems = +union IssueTimelineItems @docsCategory(name: "issues") = | AddedToProjectEvent | AddedToProjectV2Event | AssignedEvent @@ -21958,7 +21968,7 @@ enum IssueTimelineItemsItemType { """ Represents the type of Issue. """ -type IssueType implements Node { +type IssueType implements Node @docsCategory(name: "issues") { """ The issue type's color. """ @@ -22051,7 +22061,7 @@ type IssueType implements Node { """ Represents a 'issue_type_added' event on a given issue. """ -type IssueTypeAddedEvent implements Node { +type IssueTypeAddedEvent implements Node @docsCategory(name: "issues") { """ Identifies the actor who performed the event. """ @@ -22076,7 +22086,7 @@ type IssueTypeAddedEvent implements Node { """ Represents a 'issue_type_changed' event on a given issue. """ -type IssueTypeChangedEvent implements Node { +type IssueTypeChangedEvent implements Node @docsCategory(name: "issues") { """ Identifies the actor who performed the event. """ @@ -22106,7 +22116,7 @@ type IssueTypeChangedEvent implements Node { """ The possible color for an issue type """ -enum IssueTypeColor { +enum IssueTypeColor @docsCategory(name: "issues") { """ blue """ @@ -22191,7 +22201,7 @@ type IssueTypeEdge { """ Ordering options for issue types connections """ -input IssueTypeOrder { +input IssueTypeOrder @docsCategory(name: "issues") { """ The ordering direction. """ @@ -22206,7 +22216,7 @@ input IssueTypeOrder { """ Properties by which issue type connections can be ordered. """ -enum IssueTypeOrderField { +enum IssueTypeOrderField @docsCategory(name: "issues") { """ Order issue types by creation time """ @@ -22221,7 +22231,7 @@ enum IssueTypeOrderField { """ Represents a 'issue_type_removed' event on a given issue. """ -type IssueTypeRemovedEvent implements Node { +type IssueTypeRemovedEvent implements Node @docsCategory(name: "issues") { """ Identifies the actor who performed the event. """ @@ -22278,7 +22288,7 @@ type JoinedGitHubContribution implements Contribution { """ A label for categorizing Issues, Pull Requests, Milestones, or Discussions with a given Repository. """ -type Label implements Node { +type Label implements Node @docsCategory(name: "issues") { """ Identifies the label color. """ @@ -22468,7 +22478,7 @@ type LabelEdge { """ Ways in which lists of labels can be ordered upon return. """ -input LabelOrder { +input LabelOrder @docsCategory(name: "issues") { """ The direction in which to order labels by the specified field. """ @@ -22483,7 +22493,7 @@ input LabelOrder { """ Properties by which label connections can be ordered. """ -enum LabelOrderField { +enum LabelOrderField @docsCategory(name: "issues") { """ Order labels by creation time """ @@ -22503,7 +22513,7 @@ enum LabelOrderField { """ An object that can have labels assigned to it. """ -interface Labelable { +interface Labelable @docsCategory(name: "issues") { """ A list of labels associated with the object. """ @@ -22543,7 +22553,7 @@ interface Labelable { """ Represents a 'labeled' event on a given issue or pull request. """ -type LabeledEvent implements Node { +type LabeledEvent implements Node @docsCategory(name: "issues") { """ Identifies the actor who performed the event. """ @@ -22911,7 +22921,7 @@ type LinkRepositoryToProjectPayload { """ A branch linked to an issue. """ -type LinkedBranch implements Node { +type LinkedBranch implements Node @docsCategory(name: "issues") { """ The Node ID of the LinkedBranch object """ @@ -23006,7 +23016,7 @@ type LockLockablePayload { """ The possible reasons that an issue or pull request was locked. """ -enum LockReason { +enum LockReason @docsCategory(name: "issues") { """ The issue or pull request was locked because the conversation was off-topic. """ @@ -23031,7 +23041,7 @@ enum LockReason { """ An object that can be locked. """ -interface Lockable { +interface Lockable @docsCategory(name: "issues") { """ Reason that the conversation was locked. """ @@ -25158,7 +25168,7 @@ enum MigrationState { """ Represents a Milestone object on a given repository. """ -type Milestone implements Closable & Node & UniformResourceLocatable { +type Milestone implements Closable & Node & UniformResourceLocatable @docsCategory(name: "issues") { """ Indicates if the object is closed (definition of closed may depend on type) """ @@ -25398,12 +25408,12 @@ type MilestoneEdge { """ Types that can be inside a Milestone. """ -union MilestoneItem = Issue | PullRequest +union MilestoneItem @docsCategory(name: "issues") = Issue | PullRequest """ Ordering options for milestone connections. """ -input MilestoneOrder { +input MilestoneOrder @docsCategory(name: "issues") { """ The ordering direction. """ @@ -25418,7 +25428,7 @@ input MilestoneOrder { """ Properties by which milestone connections can be ordered. """ -enum MilestoneOrderField { +enum MilestoneOrderField @docsCategory(name: "issues") { """ Order milestones by when they were created. """ @@ -25443,7 +25453,7 @@ enum MilestoneOrderField { """ The possible states of a milestone. """ -enum MilestoneState { +enum MilestoneState @docsCategory(name: "issues") { """ A milestone that has been closed. """ @@ -25458,7 +25468,7 @@ enum MilestoneState { """ Represents a 'milestoned' event on a given issue or pull request. """ -type MilestonedEvent implements Node { +type MilestonedEvent implements Node @docsCategory(name: "issues") { """ Identifies the actor who performed the event. """ @@ -25637,7 +25647,7 @@ type MoveProjectColumnPayload { """ Represents a 'moved_columns_in_project' event on a given issue or pull request. """ -type MovedColumnsInProjectEvent implements Node { +type MovedColumnsInProjectEvent implements Node @docsCategory(name: "projects-classic") { """ Identifies the actor who performed the event. """ @@ -25766,7 +25776,7 @@ type Mutation { Parameters for AddAssigneesToAssignable """ input: AddAssigneesToAssignableInput! - ): AddAssigneesToAssignablePayload + ): AddAssigneesToAssignablePayload @docsCategory(name: "issues") """ Adds a 'blocked by' relationship to an issue. @@ -25776,7 +25786,7 @@ type Mutation { Parameters for AddBlockedBy """ input: AddBlockedByInput! - ): AddBlockedByPayload + ): AddBlockedByPayload @docsCategory(name: "issues") """ Adds a comment to an Issue or Pull Request. @@ -25836,7 +25846,7 @@ type Mutation { Parameters for AddLabelsToLabelable """ input: AddLabelsToLabelableInput! - ): AddLabelsToLabelablePayload + ): AddLabelsToLabelablePayload @docsCategory(name: "issues") """ Adds a card to a ProjectColumn. Either `contentId` or `note` must be provided but **not** both. @@ -25850,6 +25860,7 @@ type Mutation { @deprecated( reason: "Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC." ) + @docsCategory(name: "projects-classic") """ Adds a column to a Project. @@ -25863,6 +25874,7 @@ type Mutation { @deprecated( reason: "Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC." ) + @docsCategory(name: "projects-classic") """ Creates a new draft issue and add it to a Project. @@ -25932,7 +25944,7 @@ type Mutation { Parameters for AddReaction """ input: AddReactionInput! - ): AddReactionPayload + ): AddReactionPayload @docsCategory(name: "reactions") """ Adds a star to a Starrable. @@ -26073,7 +26085,7 @@ type Mutation { Parameters for ClearLabelsFromLabelable """ input: ClearLabelsFromLabelableInput! - ): ClearLabelsFromLabelablePayload + ): ClearLabelsFromLabelablePayload @docsCategory(name: "issues") """ This mutation clears the value of a field for an item in a Project. Currently @@ -26099,6 +26111,7 @@ type Mutation { @deprecated( reason: "Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC." ) + @docsCategory(name: "projects-classic") """ Create a new repository with the same files and directory structure as a template repository. @@ -26128,7 +26141,7 @@ type Mutation { Parameters for CloseIssue """ input: CloseIssueInput! - ): CloseIssuePayload + ): CloseIssuePayload @docsCategory(name: "issues") """ Close a pull request. @@ -26152,6 +26165,7 @@ type Mutation { @deprecated( reason: "Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC." ) + @docsCategory(name: "projects-classic") """ Converts a projectV2 draft issue item to an issue. @@ -26347,7 +26361,7 @@ type Mutation { Parameters for CreateIssue """ input: CreateIssueInput! - ): CreateIssuePayload + ): CreateIssuePayload @docsCategory(name: "issues") """ Creates a new issue field. @@ -26357,7 +26371,7 @@ type Mutation { Parameters for CreateIssueField """ input: CreateIssueFieldInput! - ): CreateIssueFieldPayload + ): CreateIssueFieldPayload @docsCategory(name: "issues") """ Creates a new issue field value for an issue. @@ -26367,7 +26381,7 @@ type Mutation { Parameters for CreateIssueFieldValue """ input: CreateIssueFieldValueInput! - ): CreateIssueFieldValuePayload + ): CreateIssueFieldValuePayload @docsCategory(name: "issues") """ Creates a new issue type @@ -26377,7 +26391,7 @@ type Mutation { Parameters for CreateIssueType """ input: CreateIssueTypeInput! - ): CreateIssueTypePayload + ): CreateIssueTypePayload @docsCategory(name: "issues") """ Creates a new label. @@ -26387,7 +26401,7 @@ type Mutation { Parameters for CreateLabel """ input: CreateLabelInput! - ): CreateLabelPayload + ): CreateLabelPayload @docsCategory(name: "issues") """ Create a branch linked to an issue. @@ -26397,7 +26411,7 @@ type Mutation { Parameters for CreateLinkedBranch """ input: CreateLinkedBranchInput! - ): CreateLinkedBranchPayload + ): CreateLinkedBranchPayload @docsCategory(name: "issues") """ Creates a GitHub Enterprise Importer (GEI) migration source. @@ -26421,6 +26435,7 @@ type Mutation { @deprecated( reason: "Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC." ) + @docsCategory(name: "projects-classic") """ Creates a new project. @@ -26641,7 +26656,7 @@ type Mutation { Parameters for DeleteIssue """ input: DeleteIssueInput! - ): DeleteIssuePayload + ): DeleteIssuePayload @docsCategory(name: "issues") """ Deletes an IssueComment object. @@ -26651,7 +26666,7 @@ type Mutation { Parameters for DeleteIssueComment """ input: DeleteIssueCommentInput! - ): DeleteIssueCommentPayload + ): DeleteIssueCommentPayload @docsCategory(name: "issues") """ Deletes an issue field. @@ -26661,7 +26676,7 @@ type Mutation { Parameters for DeleteIssueField """ input: DeleteIssueFieldInput! - ): DeleteIssueFieldPayload + ): DeleteIssueFieldPayload @docsCategory(name: "issues") """ Deletes an issue field value from an issue. @@ -26671,7 +26686,7 @@ type Mutation { Parameters for DeleteIssueFieldValue """ input: DeleteIssueFieldValueInput! - ): DeleteIssueFieldValuePayload + ): DeleteIssueFieldValuePayload @docsCategory(name: "issues") """ Delete an issue type @@ -26681,7 +26696,7 @@ type Mutation { Parameters for DeleteIssueType """ input: DeleteIssueTypeInput! - ): DeleteIssueTypePayload + ): DeleteIssueTypePayload @docsCategory(name: "issues") """ Deletes a label. @@ -26691,7 +26706,7 @@ type Mutation { Parameters for DeleteLabel """ input: DeleteLabelInput! - ): DeleteLabelPayload + ): DeleteLabelPayload @docsCategory(name: "issues") """ Unlink a branch from an issue. @@ -26701,7 +26716,7 @@ type Mutation { Parameters for DeleteLinkedBranch """ input: DeleteLinkedBranchInput! - ): DeleteLinkedBranchPayload + ): DeleteLinkedBranchPayload @docsCategory(name: "issues") """ Delete a package version. @@ -26725,6 +26740,7 @@ type Mutation { @deprecated( reason: "Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC." ) + @docsCategory(name: "projects-classic") """ Deletes a project card. @@ -26738,6 +26754,7 @@ type Mutation { @deprecated( reason: "Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC." ) + @docsCategory(name: "projects-classic") """ Deletes a project column. @@ -26751,6 +26768,7 @@ type Mutation { @deprecated( reason: "Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC." ) + @docsCategory(name: "projects-classic") """ Delete a project. @@ -26984,6 +27002,7 @@ type Mutation { @deprecated( reason: "Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC." ) + @docsCategory(name: "migrations") """ Invite someone to become an administrator of the enterprise. @@ -27037,6 +27056,7 @@ type Mutation { @deprecated( reason: "Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC." ) + @docsCategory(name: "projects-classic") """ Lock a lockable object @@ -27046,7 +27066,7 @@ type Mutation { Parameters for LockLockable """ input: LockLockableInput! - ): LockLockablePayload + ): LockLockablePayload @docsCategory(name: "issues") """ Mark a discussion comment as the chosen answer for discussions in an answerable category. @@ -27130,6 +27150,7 @@ type Mutation { @deprecated( reason: "Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC." ) + @docsCategory(name: "projects-classic") """ Moves a project column to another place. @@ -27143,6 +27164,7 @@ type Mutation { @deprecated( reason: "Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC." ) + @docsCategory(name: "projects-classic") """ Pin an environment to a repository @@ -27162,7 +27184,7 @@ type Mutation { Parameters for PinIssue """ input: PinIssueInput! - ): PinIssuePayload + ): PinIssuePayload @docsCategory(name: "issues") """ Pins an Issue Comment. @@ -27172,7 +27194,7 @@ type Mutation { Parameters for PinIssueComment """ input: PinIssueCommentInput! - ): PinIssueCommentPayload + ): PinIssueCommentPayload @docsCategory(name: "issues") """ Promote a repository custom property to the enterprise level. @@ -27232,7 +27254,7 @@ type Mutation { Parameters for RemoveAssigneesFromAssignable """ input: RemoveAssigneesFromAssignableInput! - ): RemoveAssigneesFromAssignablePayload + ): RemoveAssigneesFromAssignablePayload @docsCategory(name: "issues") """ Removes a 'blocked by' relationship from an issue. @@ -27242,7 +27264,7 @@ type Mutation { Parameters for RemoveBlockedBy """ input: RemoveBlockedByInput! - ): RemoveBlockedByPayload + ): RemoveBlockedByPayload @docsCategory(name: "issues") """ Removes an administrator from the enterprise. @@ -27303,7 +27325,7 @@ type Mutation { Parameters for RemoveLabelsFromLabelable """ input: RemoveLabelsFromLabelableInput! - ): RemoveLabelsFromLabelablePayload + ): RemoveLabelsFromLabelablePayload @docsCategory(name: "issues") """ Removes outside collaborator from all repositories in an organization. @@ -27323,7 +27345,7 @@ type Mutation { Parameters for RemoveReaction """ input: RemoveReactionInput! - ): RemoveReactionPayload + ): RemoveReactionPayload @docsCategory(name: "reactions") """ Removes a star from a Starrable. @@ -27373,7 +27395,7 @@ type Mutation { Parameters for ReopenIssue """ input: ReopenIssueInput! - ): ReopenIssuePayload + ): ReopenIssuePayload @docsCategory(name: "issues") """ Reopen a pull request. @@ -27383,7 +27405,7 @@ type Mutation { Parameters for ReopenPullRequest """ input: ReopenPullRequestInput! - ): ReopenPullRequestPayload + ): ReopenPullRequestPayload @docsCategory(name: "pulls") """ Reorder a pinned repository environment @@ -27403,7 +27425,7 @@ type Mutation { Parameters for ReplaceActorsForAssignable """ input: ReplaceActorsForAssignableInput! - ): ReplaceActorsForAssignablePayload + ): ReplaceActorsForAssignablePayload @docsCategory(name: "issues") """ Reprioritizes a sub-issue to a different position in the parent list. @@ -27513,7 +27535,7 @@ type Mutation { Parameters for SetIssueFieldValue """ input: SetIssueFieldValueInput! - ): SetIssueFieldValuePayload + ): SetIssueFieldValuePayload @docsCategory(name: "issues") """ Set an organization level interaction limit for an organization's public repositories. @@ -27603,7 +27625,7 @@ type Mutation { Parameters for TransferIssue """ input: TransferIssueInput! - ): TransferIssuePayload + ): TransferIssuePayload @docsCategory(name: "issues") """ Unarchives a ProjectV2Item @@ -27689,6 +27711,7 @@ type Mutation { @deprecated( reason: "Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC." ) + @docsCategory(name: "projects-classic") """ Unlock a lockable object @@ -27698,7 +27721,7 @@ type Mutation { Parameters for UnlockLockable """ input: UnlockLockableInput! - ): UnlockLockablePayload + ): UnlockLockablePayload @docsCategory(name: "issues") """ Unmark a discussion comment as the chosen answer for discussions in an answerable category. @@ -27728,7 +27751,7 @@ type Mutation { Parameters for UnmarkIssueAsDuplicate """ input: UnmarkIssueAsDuplicateInput! - ): UnmarkIssueAsDuplicatePayload + ): UnmarkIssueAsDuplicatePayload @docsCategory(name: "issues") """ Unmark a project as a template. @@ -27758,7 +27781,7 @@ type Mutation { Parameters for UnpinIssue """ input: UnpinIssueInput! - ): UnpinIssuePayload + ): UnpinIssuePayload @docsCategory(name: "issues") """ Unpins an Issue Comment. @@ -27768,7 +27791,7 @@ type Mutation { Parameters for UnpinIssueComment """ input: UnpinIssueCommentInput! - ): UnpinIssueCommentPayload + ): UnpinIssueCommentPayload @docsCategory(name: "issues") """ Marks a review thread as unresolved. @@ -27898,7 +27921,7 @@ type Mutation { Parameters for UpdateEnterpriseMembersCanDeleteIssuesSetting """ input: UpdateEnterpriseMembersCanDeleteIssuesSettingInput! - ): UpdateEnterpriseMembersCanDeleteIssuesSettingPayload + ): UpdateEnterpriseMembersCanDeleteIssuesSettingPayload @docsCategory(name: "enterprise-admin") """ Sets the members can delete repositories setting for an enterprise. @@ -28068,7 +28091,7 @@ type Mutation { Parameters for UpdateIssue """ input: UpdateIssueInput! - ): UpdateIssuePayload + ): UpdateIssuePayload @docsCategory(name: "issues") """ Updates an IssueComment object. @@ -28078,7 +28101,7 @@ type Mutation { Parameters for UpdateIssueComment """ input: UpdateIssueCommentInput! - ): UpdateIssueCommentPayload + ): UpdateIssueCommentPayload @docsCategory(name: "issues") """ Updates an issue field. @@ -28088,7 +28111,7 @@ type Mutation { Parameters for UpdateIssueField """ input: UpdateIssueFieldInput! - ): UpdateIssueFieldPayload + ): UpdateIssueFieldPayload @docsCategory(name: "issues") """ Updates an existing issue field value for an issue. @@ -28098,7 +28121,7 @@ type Mutation { Parameters for UpdateIssueFieldValue """ input: UpdateIssueFieldValueInput! - ): UpdateIssueFieldValuePayload + ): UpdateIssueFieldValuePayload @docsCategory(name: "issues") """ Updates the issue type on an issue @@ -28108,7 +28131,7 @@ type Mutation { Parameters for UpdateIssueIssueType """ input: UpdateIssueIssueTypeInput! - ): UpdateIssueIssueTypePayload + ): UpdateIssueIssueTypePayload @docsCategory(name: "issues") """ Update an issue type @@ -28118,7 +28141,7 @@ type Mutation { Parameters for UpdateIssueType """ input: UpdateIssueTypeInput! - ): UpdateIssueTypePayload + ): UpdateIssueTypePayload @docsCategory(name: "issues") """ Updates an existing label. @@ -28128,7 +28151,7 @@ type Mutation { Parameters for UpdateLabel """ input: UpdateLabelInput! - ): UpdateLabelPayload + ): UpdateLabelPayload @docsCategory(name: "issues") """ Update the setting to restrict notifications to only verified or approved domains available to an owner. @@ -28185,6 +28208,7 @@ type Mutation { @deprecated( reason: "Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC." ) + @docsCategory(name: "projects-classic") """ Updates an existing project card. @@ -28198,6 +28222,7 @@ type Mutation { @deprecated( reason: "Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC." ) + @docsCategory(name: "projects-classic") """ Updates an existing project column. @@ -28211,6 +28236,7 @@ type Mutation { @deprecated( reason: "Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC." ) + @docsCategory(name: "projects-classic") """ Updates an existing project. @@ -36944,7 +36970,7 @@ type PinIssuePayload { """ Entities that can be pinned. """ -interface Pinnable { +interface Pinnable @docsCategory(name: "users") { """ Indicates whether or not this entity is currently pinned. """ @@ -37349,7 +37375,7 @@ type PinnedEvent implements Node { """ A Pinned Issue is a issue pinned to a repository's index page. """ -type PinnedIssue implements Node { +type PinnedIssue implements Node @docsCategory(name: "issues") { """ Identifies the primary key from the database. """ @@ -37384,7 +37410,7 @@ type PinnedIssue implements Node { """ A comment pinned to an Issue. """ -type PinnedIssueComment implements Node { +type PinnedIssueComment implements Node @docsCategory(name: "issues") { """ Identifies the primary key from the database. """ @@ -37990,7 +38016,7 @@ interface ProfileOwner { """ Projects manage issues, pull requests and notes within a project owner. """ -type Project implements Closable & Node & Updatable { +type Project implements Closable & Node & Updatable @docsCategory(name: "projects-classic") { """ The project's description body. """ @@ -38193,7 +38219,7 @@ type Project implements Closable & Node & Updatable { """ A card in a project. """ -type ProjectCard implements Node { +type ProjectCard implements Node @docsCategory(name: "projects-classic") { """ The project column this card is associated under. A card may only belong to one project column at a time. The column field will be null if the card is created @@ -38305,7 +38331,7 @@ type ProjectCard implements Node { """ The possible archived states of a project card. """ -enum ProjectCardArchivedState { +enum ProjectCardArchivedState @docsCategory(name: "projects-classic") { """ A project card that is archived """ @@ -38366,7 +38392,7 @@ type ProjectCardEdge { """ An issue or PR and its owning repository to be used in a project card. """ -input ProjectCardImport { +input ProjectCardImport @docsCategory(name: "projects-classic") { """ The issue or pull request number. """ @@ -38381,12 +38407,12 @@ input ProjectCardImport { """ Types that can be inside Project Cards. """ -union ProjectCardItem = Issue | PullRequest +union ProjectCardItem @docsCategory(name: "projects-classic") = Issue | PullRequest """ Various content states of a ProjectCard """ -enum ProjectCardState { +enum ProjectCardState @docsCategory(name: "projects-classic") { """ The card has content only. """ @@ -38406,7 +38432,7 @@ enum ProjectCardState { """ A column inside a project. """ -type ProjectColumn implements Node { +type ProjectColumn implements Node @docsCategory(name: "projects-classic") { """ List of cards in the column """ @@ -38556,7 +38582,7 @@ type ProjectColumnEdge { """ A project column and a list of its issues and PRs. """ -input ProjectColumnImport { +input ProjectColumnImport @docsCategory(name: "projects-classic") { """ The name of the column. """ @@ -38576,7 +38602,7 @@ input ProjectColumnImport { """ The semantic purpose of the column - todo, in progress, or done. """ -enum ProjectColumnPurpose { +enum ProjectColumnPurpose @docsCategory(name: "projects-classic") { """ The column contains cards which are complete """ @@ -38636,7 +38662,7 @@ type ProjectEdge { """ Ways in which lists of projects can be ordered upon return. """ -input ProjectOrder { +input ProjectOrder @docsCategory(name: "projects-classic") { """ The direction in which to order projects by the specified field. """ @@ -38651,7 +38677,7 @@ input ProjectOrder { """ Properties by which project connections can be ordered. """ -enum ProjectOrderField { +enum ProjectOrderField @docsCategory(name: "projects-classic") { """ Order projects by creation time """ @@ -38671,7 +38697,7 @@ enum ProjectOrderField { """ Represents an owner of a Project. """ -interface ProjectOwner { +interface ProjectOwner @docsCategory(name: "projects-classic") { """ The Node ID of the ProjectOwner object """ @@ -38764,7 +38790,7 @@ interface ProjectOwner { """ Project progress stats. """ -type ProjectProgress { +type ProjectProgress @docsCategory(name: "projects-classic") { """ The number of done cards. """ @@ -38825,7 +38851,7 @@ type ProjectProgress { """ State of the project; either 'open' or 'closed' """ -enum ProjectState { +enum ProjectState @docsCategory(name: "projects-classic") { """ The project is closed. """ @@ -38840,7 +38866,7 @@ enum ProjectState { """ GitHub-provided templates for Projects """ -enum ProjectTemplate { +enum ProjectTemplate @docsCategory(name: "projects-classic") { """ Create a board with v2 triggers to automatically move cards across To do, In progress and Done columns. """ @@ -46062,7 +46088,7 @@ type RateLimit { """ Represents a subject that can be reacted on. """ -interface Reactable { +interface Reactable @docsCategory(name: "reactions") { """ Identifies the primary key from the database. """ @@ -46163,7 +46189,7 @@ type ReactingUserEdge { """ An emoji reaction to a particular piece of content. """ -type Reaction implements Node { +type Reaction implements Node @docsCategory(name: "reactions") { """ Identifies the emoji reaction. """ @@ -46228,7 +46254,7 @@ type ReactionConnection { """ Emojis that can be attached to Issues, Pull Requests and Comments. """ -enum ReactionContent { +enum ReactionContent @docsCategory(name: "reactions") { """ Represents the `:confused:` emoji. """ @@ -46288,7 +46314,7 @@ type ReactionEdge { """ A group of emoji reactions to a particular piece of content. """ -type ReactionGroup { +type ReactionGroup @docsCategory(name: "reactions") { """ Identifies the emoji reaction. """ @@ -46366,7 +46392,7 @@ type ReactionGroup { """ Ways in which lists of reactions can be ordered upon return. """ -input ReactionOrder { +input ReactionOrder @docsCategory(name: "reactions") { """ The direction in which to order reactions by the specified field. """ @@ -46381,7 +46407,7 @@ input ReactionOrder { """ A list of fields that reactions can be ordered by. """ -enum ReactionOrderField { +enum ReactionOrderField @docsCategory(name: "reactions") { """ Allows ordering a list of reactions by when they were created. """ @@ -46391,7 +46417,7 @@ enum ReactionOrderField { """ Types that can be assigned to reactions. """ -union Reactor = Bot | Mannequin | Organization | User +union Reactor @docsCategory(name: "reactions") = Bot | Mannequin | Organization | User """ The connection type for Reactor. @@ -46950,7 +46976,7 @@ type RejectDeploymentsPayload { """ A release contains the content for a release. """ -type Release implements Node & Reactable & UniformResourceLocatable { +type Release implements Node & Reactable & UniformResourceLocatable @docsCategory(name: "releases") { """ The author of the release """ @@ -47160,7 +47186,7 @@ type Release implements Node & Reactable & UniformResourceLocatable { """ A release asset contains the content for a release asset. """ -type ReleaseAsset implements Node { +type ReleaseAsset implements Node @docsCategory(name: "releases") { """ The asset's content-type """ @@ -47305,7 +47331,7 @@ type ReleaseEdge { """ Ways in which lists of releases can be ordered upon return. """ -input ReleaseOrder { +input ReleaseOrder @docsCategory(name: "releases") { """ The direction in which to order releases by the specified field. """ @@ -47320,7 +47346,7 @@ input ReleaseOrder { """ Properties by which release connections can be ordered. """ -enum ReleaseOrderField { +enum ReleaseOrderField @docsCategory(name: "releases") { """ Order releases by creation time """ @@ -47893,7 +47919,7 @@ type RemovedFromMergeQueueEvent implements Node { """ Represents a 'removed_from_project' event on a given issue or pull request. """ -type RemovedFromProjectEvent implements Node { +type RemovedFromProjectEvent implements Node @docsCategory(name: "projects-classic") { """ Identifies the actor who performed the event. """ @@ -53683,7 +53709,7 @@ type RepositoryConnection { """ A repository contact link. """ -type RepositoryContactLink { +type RepositoryContactLink @docsCategory(name: "repos") { """ The contact link purpose. """ @@ -55590,7 +55616,7 @@ enum RepositoryRulesetTarget { """ The possible filters for suggested actors in a repository """ -enum RepositorySuggestedActorFilter { +enum RepositorySuggestedActorFilter @docsCategory(name: "repos") { """ Actors that can be assigned to issues and pull requests """ @@ -64668,7 +64694,7 @@ enum TopicSuggestionDeclineReason { """ The possible states of a tracked issue. """ -enum TrackedIssueStates { +enum TrackedIssueStates @docsCategory(name: "issues") { """ The tracked issue is closed """ @@ -64758,7 +64784,7 @@ type TransferIssuePayload { """ Represents a 'transferred' event on a given issue or pull request. """ -type TransferredEvent implements Node { +type TransferredEvent implements Node @docsCategory(name: "issues") { """ Identifies the actor who performed the event. """ @@ -65185,7 +65211,7 @@ type UnknownSignature implements GitSignature { """ Represents an 'unlabeled' event on a given issue or pull request. """ -type UnlabeledEvent implements Node { +type UnlabeledEvent implements Node @docsCategory(name: "issues") { """ Identifies the actor who performed the event. """ @@ -65656,7 +65682,7 @@ type UnpinIssuePayload { """ Represents an 'unpinned' event on a given issue or pull request. """ -type UnpinnedEvent implements Node { +type UnpinnedEvent implements Node @docsCategory(name: "issues") { """ Identifies the actor who performed the event. """ @@ -65746,7 +65772,7 @@ interface Updatable { """ Comments that can be updated. """ -interface UpdatableComment { +interface UpdatableComment @docsCategory(name: "issues") { """ Reasons why the current viewer can not update this comment. """ diff --git a/src/graphql/data/fpt/schema.json b/src/graphql/data/fpt/schema.json index 3b44fc3b3059..8512f967a29d 100644 --- a/src/graphql/data/fpt/schema.json +++ b/src/graphql/data/fpt/schema.json @@ -1027,6 +1027,7 @@ "id": "addassigneestoassignable", "href": "/graphql/reference/mutations#addassigneestoassignable", "description": "

Adds assignees to an assignable object.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -1057,6 +1058,7 @@ "id": "addblockedby", "href": "/graphql/reference/mutations#addblockedby", "description": "

Adds a 'blocked by' relationship to an issue.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -1258,6 +1260,7 @@ "id": "addlabelstolabelable", "href": "/graphql/reference/mutations#addlabelstolabelable", "description": "

Adds labels to a labelable object.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -1560,6 +1563,7 @@ "id": "addreaction", "href": "/graphql/reference/mutations#addreaction", "description": "

Adds a reaction to a subject.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -2015,6 +2019,7 @@ "id": "clearlabelsfromlabelable", "href": "/graphql/reference/mutations#clearlabelsfromlabelable", "description": "

Clears all labels from a labelable object.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -2174,6 +2179,7 @@ "id": "closeissue", "href": "/graphql/reference/mutations#closeissue", "description": "

Close an issue.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -2721,6 +2727,7 @@ "id": "createissue", "href": "/graphql/reference/mutations#createissue", "description": "

Creates a new issue.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -2751,6 +2758,7 @@ "id": "createissuefield", "href": "/graphql/reference/mutations#createissuefield", "description": "

Creates a new issue field.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -2781,6 +2789,7 @@ "id": "createissuefieldvalue", "href": "/graphql/reference/mutations#createissuefieldvalue", "description": "

Creates a new issue field value for an issue.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -2818,6 +2827,7 @@ "id": "createissuetype", "href": "/graphql/reference/mutations#createissuetype", "description": "

Creates a new issue type.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -2848,6 +2858,7 @@ "id": "createlabel", "href": "/graphql/reference/mutations#createlabel", "description": "

Creates a new label.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -2878,6 +2889,7 @@ "id": "createlinkedbranch", "href": "/graphql/reference/mutations#createlinkedbranch", "description": "

Create a branch linked to an issue.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -3595,6 +3607,7 @@ "id": "deleteissue", "href": "/graphql/reference/mutations#deleteissue", "description": "

Deletes an Issue object.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -3625,6 +3638,7 @@ "id": "deleteissuecomment", "href": "/graphql/reference/mutations#deleteissuecomment", "description": "

Deletes an IssueComment object.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -3648,6 +3662,7 @@ "id": "deleteissuefield", "href": "/graphql/reference/mutations#deleteissuefield", "description": "

Deletes an issue field.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -3678,6 +3693,7 @@ "id": "deleteissuefieldvalue", "href": "/graphql/reference/mutations#deleteissuefieldvalue", "description": "

Deletes an issue field value from an issue.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -3715,6 +3731,7 @@ "id": "deleteissuetype", "href": "/graphql/reference/mutations#deleteissuetype", "description": "

Delete an issue type.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -3745,6 +3762,7 @@ "id": "deletelabel", "href": "/graphql/reference/mutations#deletelabel", "description": "

Deletes a label.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -3768,6 +3786,7 @@ "id": "deletelinkedbranch", "href": "/graphql/reference/mutations#deletelinkedbranch", "description": "

Unlink a branch from an issue.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -4810,6 +4829,7 @@ "id": "locklockable", "href": "/graphql/reference/mutations#locklockable", "description": "

Lock a lockable object.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -5165,6 +5185,7 @@ "id": "pinissue", "href": "/graphql/reference/mutations#pinissue", "description": "

Pin an issue to a repository.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -5195,6 +5216,7 @@ "id": "pinissuecomment", "href": "/graphql/reference/mutations#pinissuecomment", "description": "

Pins an Issue Comment.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -5375,6 +5397,7 @@ "id": "removeassigneesfromassignable", "href": "/graphql/reference/mutations#removeassigneesfromassignable", "description": "

Removes assignees from an assignable object.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -5405,6 +5428,7 @@ "id": "removeblockedby", "href": "/graphql/reference/mutations#removeblockedby", "description": "

Removes a 'blocked by' relationship from an issue.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -5641,6 +5665,7 @@ "id": "removelabelsfromlabelable", "href": "/graphql/reference/mutations#removelabelsfromlabelable", "description": "

Removes labels from a Labelable object.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -5701,6 +5726,7 @@ "id": "removereaction", "href": "/graphql/reference/mutations#removereaction", "description": "

Removes a reaction from a subject.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -5872,6 +5898,7 @@ "id": "reopenissue", "href": "/graphql/reference/mutations#reopenissue", "description": "

Reopen a issue.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -5902,6 +5929,7 @@ "id": "reopenpullrequest", "href": "/graphql/reference/mutations#reopenpullrequest", "description": "

Reopen a pull request.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -5962,6 +5990,7 @@ "id": "replaceactorsforassignable", "href": "/graphql/reference/mutations#replaceactorsforassignable", "description": "

Replaces all actors for assignable object.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -6327,6 +6356,7 @@ "id": "setissuefieldvalue", "href": "/graphql/reference/mutations#setissuefieldvalue", "description": "

Sets the value of an IssueFieldValue.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -6604,6 +6634,7 @@ "id": "transferissue", "href": "/graphql/reference/mutations#transferissue", "description": "

Transfer an issue to a different repository.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -6883,6 +6914,7 @@ "id": "unlocklockable", "href": "/graphql/reference/mutations#unlocklockable", "description": "

Unlock a lockable object.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -6980,6 +7012,7 @@ "id": "unmarkissueasduplicate", "href": "/graphql/reference/mutations#unmarkissueasduplicate", "description": "

Unmark an issue as a duplicate of another issue.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -7070,6 +7103,7 @@ "id": "unpinissue", "href": "/graphql/reference/mutations#unpinissue", "description": "

Unpin a pinned issue from a repository.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -7107,6 +7141,7 @@ "id": "unpinissuecomment", "href": "/graphql/reference/mutations#unpinissuecomment", "description": "

Unpins an Issue Comment.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -7532,6 +7567,7 @@ "id": "updateenterprisememberscandeleteissuessetting", "href": "/graphql/reference/mutations#updateenterprisememberscandeleteissuessetting", "description": "

Sets the members can delete issues setting for an enterprise.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -8112,6 +8148,7 @@ "id": "updateissue", "href": "/graphql/reference/mutations#updateissue", "description": "

Updates an Issue.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -8149,6 +8186,7 @@ "id": "updateissuecomment", "href": "/graphql/reference/mutations#updateissuecomment", "description": "

Updates an IssueComment object.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -8179,6 +8217,7 @@ "id": "updateissuefield", "href": "/graphql/reference/mutations#updateissuefield", "description": "

Updates an issue field.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -8209,6 +8248,7 @@ "id": "updateissuefieldvalue", "href": "/graphql/reference/mutations#updateissuefieldvalue", "description": "

Updates an existing issue field value for an issue.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -8246,6 +8286,7 @@ "id": "updateissueissuetype", "href": "/graphql/reference/mutations#updateissueissuetype", "description": "

Updates the issue type on an issue.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -8276,6 +8317,7 @@ "id": "updateissuetype", "href": "/graphql/reference/mutations#updateissuetype", "description": "

Update an issue type.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -8306,6 +8348,7 @@ "id": "updatelabel", "href": "/graphql/reference/mutations#updatelabel", "description": "

Updates an existing label.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -9511,6 +9554,7 @@ "id": "addedtoprojectevent", "href": "/graphql/reference/objects#addedtoprojectevent", "description": "

Represents aadded_to_projectevent on a given issue or pull request.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -9674,6 +9718,7 @@ "id": "app", "href": "/graphql/reference/objects#app", "description": "

A GitHub App.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -10652,6 +10697,7 @@ "id": "blockedbyaddedevent", "href": "/graphql/reference/objects#blockedbyaddedevent", "description": "

Represents ablocked_by_addedevent on a given issue.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -10695,6 +10741,7 @@ "id": "blockedbyremovedevent", "href": "/graphql/reference/objects#blockedbyremovedevent", "description": "

Represents ablocked_by_removedevent on a given issue.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -10738,6 +10785,7 @@ "id": "blockingaddedevent", "href": "/graphql/reference/objects#blockingaddedevent", "description": "

Represents ablocking_addedevent on a given issue.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -10781,6 +10829,7 @@ "id": "blockingremovedevent", "href": "/graphql/reference/objects#blockingremovedevent", "description": "

Represents ablocking_removedevent on a given issue.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -10824,6 +10873,7 @@ "id": "bot", "href": "/graphql/reference/objects#bot", "description": "

A special type of user which takes actions on behalf of GitHub Apps.

", + "isDeprecated": false, "implements": [ { "name": "Actor", @@ -14811,6 +14861,7 @@ "id": "connectedevent", "href": "/graphql/reference/objects#connectedevent", "description": "

Represents aconnectedevent on a given issue or pull request.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -15803,6 +15854,7 @@ "id": "convertedfromdraftevent", "href": "/graphql/reference/objects#convertedfromdraftevent", "description": "

Represents aconverted_from_draftevent on a given issue or pull request.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -16735,6 +16787,7 @@ "id": "demilestonedevent", "href": "/graphql/reference/objects#demilestonedevent", "description": "

Represents ademilestonedevent on a given issue or pull request.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -18246,6 +18299,7 @@ "id": "disconnectedevent", "href": "/graphql/reference/objects#disconnectedevent", "description": "

Represents adisconnectedevent on a given issue or pull request.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -26345,6 +26399,7 @@ "id": "issue", "href": "/graphql/reference/objects#issue", "description": "

An Issue is a place to discuss ideas, enhancements, tasks, and bugs for a project.

", + "isDeprecated": false, "implements": [ { "name": "Assignable", @@ -27986,6 +28041,7 @@ "id": "issuecomment", "href": "/graphql/reference/objects#issuecomment", "description": "

Represents a comment on an Issue.

", + "isDeprecated": false, "implements": [ { "name": "Comment", @@ -28452,6 +28508,7 @@ "id": "issuecommentpinnedevent", "href": "/graphql/reference/objects#issuecommentpinnedevent", "description": "

Represents aissue_comment_pinnedevent on a given issue.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -28495,6 +28552,7 @@ "id": "issuecommentunpinnedevent", "href": "/graphql/reference/objects#issuecommentunpinnedevent", "description": "

Represents aissue_comment_unpinnedevent on a given issue.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -28574,6 +28632,7 @@ "id": "issuecontributionsbyrepository", "href": "/graphql/reference/objects#issuecontributionsbyrepository", "description": "

This aggregates issues opened by a user within one repository.

", + "isDeprecated": false, "fields": [ { "name": "contributions", @@ -28643,6 +28702,7 @@ "id": "issuedependenciessummary", "href": "/graphql/reference/objects#issuedependenciessummary", "description": "

Summary of the state of an issue's dependencies.

", + "isDeprecated": false, "fields": [ { "name": "blockedBy", @@ -28701,6 +28761,7 @@ "id": "issuefieldaddedevent", "href": "/graphql/reference/objects#issuefieldaddedevent", "description": "

Represents aissue_field_addedevent on a given issue.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -28758,6 +28819,7 @@ "id": "issuefieldchangedevent", "href": "/graphql/reference/objects#issuefieldchangedevent", "description": "

Represents aissue_field_changedevent on a given issue.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -28829,6 +28891,7 @@ "id": "issuefielddate", "href": "/graphql/reference/objects#issuefielddate", "description": "

Represents a date issue field.

", + "isDeprecated": false, "implements": [ { "name": "IssueFieldCommon", @@ -28891,6 +28954,7 @@ "id": "issuefielddatevalue", "href": "/graphql/reference/objects#issuefielddatevalue", "description": "

The value of a date field in an Issue item.

", + "isDeprecated": false, "implements": [ { "name": "IssueFieldValueCommon", @@ -28932,6 +28996,7 @@ "id": "issuefieldnumber", "href": "/graphql/reference/objects#issuefieldnumber", "description": "

Represents a number issue field.

", + "isDeprecated": false, "implements": [ { "name": "IssueFieldCommon", @@ -28994,6 +29059,7 @@ "id": "issuefieldnumbervalue", "href": "/graphql/reference/objects#issuefieldnumbervalue", "description": "

The value of a number field in an Issue item.

", + "isDeprecated": false, "implements": [ { "name": "IssueFieldValueCommon", @@ -29035,6 +29101,7 @@ "id": "issuefieldremovedevent", "href": "/graphql/reference/objects#issuefieldremovedevent", "description": "

Represents aissue_field_removedevent on a given issue.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -29078,6 +29145,7 @@ "id": "issuefieldsingleselect", "href": "/graphql/reference/objects#issuefieldsingleselect", "description": "

Represents a single select issue field.

", + "isDeprecated": false, "implements": [ { "name": "IssueFieldCommon", @@ -29147,6 +29215,7 @@ "id": "issuefieldsingleselectoption", "href": "/graphql/reference/objects#issuefieldsingleselectoption", "description": "

Represents an option in a single-select issue field.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -29197,6 +29266,7 @@ "id": "issuefieldsingleselectvalue", "href": "/graphql/reference/objects#issuefieldsingleselectvalue", "description": "

The value of a single select field in an Issue item.

", + "isDeprecated": false, "implements": [ { "name": "IssueFieldValueCommon", @@ -29266,6 +29336,7 @@ "id": "issuefieldtext", "href": "/graphql/reference/objects#issuefieldtext", "description": "

Represents a text issue field.

", + "isDeprecated": false, "implements": [ { "name": "IssueFieldCommon", @@ -29328,6 +29399,7 @@ "id": "issuefieldtextvalue", "href": "/graphql/reference/objects#issuefieldtextvalue", "description": "

The value of a text field in an Issue item.

", + "isDeprecated": false, "implements": [ { "name": "IssueFieldValueCommon", @@ -29485,6 +29557,7 @@ "id": "issuetemplate", "href": "/graphql/reference/objects#issuetemplate", "description": "

A repository issue template.

", + "isDeprecated": false, "fields": [ { "name": "about", @@ -29771,6 +29844,7 @@ "id": "issuetype", "href": "/graphql/reference/objects#issuetype", "description": "

Represents the type of Issue.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -29927,6 +30001,7 @@ "id": "issuetypeaddedevent", "href": "/graphql/reference/objects#issuetypeaddedevent", "description": "

Represents aissue_type_addedevent on a given issue.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -29970,6 +30045,7 @@ "id": "issuetypechangedevent", "href": "/graphql/reference/objects#issuetypechangedevent", "description": "

Represents aissue_type_changedevent on a given issue.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -30078,6 +30154,7 @@ "id": "issuetyperemovedevent", "href": "/graphql/reference/objects#issuetyperemovedevent", "description": "

Represents aissue_type_removedevent on a given issue.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -30171,6 +30248,7 @@ "id": "label", "href": "/graphql/reference/objects#label", "description": "

A label for categorizing Issues, Pull Requests, Milestones, or Discussions with a given Repository.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -30485,6 +30563,7 @@ "id": "labeledevent", "href": "/graphql/reference/objects#labeledevent", "description": "

Represents alabeledevent on a given issue or pull request.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -30792,6 +30871,7 @@ "id": "linkedbranch", "href": "/graphql/reference/objects#linkedbranch", "description": "

A branch linked to an issue.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -32960,6 +33040,7 @@ "id": "milestone", "href": "/graphql/reference/objects#milestone", "description": "

Represents a Milestone object on a given repository.

", + "isDeprecated": false, "implements": [ { "name": "Closable", @@ -33354,6 +33435,7 @@ "id": "milestonedevent", "href": "/graphql/reference/objects#milestonedevent", "description": "

Represents amilestonedevent on a given issue or pull request.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -33404,6 +33486,7 @@ "id": "movedcolumnsinprojectevent", "href": "/graphql/reference/objects#movedcolumnsinprojectevent", "description": "

Represents amoved_columns_in_projectevent on a given issue or pull request.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -44312,6 +44395,7 @@ "id": "pinnedissue", "href": "/graphql/reference/objects#pinnedissue", "description": "

A Pinned Issue is a issue pinned to a repository's index page.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -44369,6 +44453,7 @@ "id": "pinnedissuecomment", "href": "/graphql/reference/objects#pinnedissuecomment", "description": "

A comment pinned to an Issue.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -45039,6 +45124,7 @@ "id": "project", "href": "/graphql/reference/objects#project", "description": "

Projects manage issues, pull requests and notes within a project owner.

", + "isDeprecated": false, "implements": [ { "name": "Closable", @@ -45328,6 +45414,7 @@ "id": "projectcard", "href": "/graphql/reference/objects#projectcard", "description": "

A card in a project.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -45518,6 +45605,7 @@ "id": "projectcolumn", "href": "/graphql/reference/objects#projectcolumn", "description": "

A column inside a project.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -45786,6 +45874,7 @@ "id": "projectprogress", "href": "/graphql/reference/objects#projectprogress", "description": "

Project progress stats.

", + "isDeprecated": false, "fields": [ { "name": "doneCount", @@ -53797,6 +53886,7 @@ "id": "reaction", "href": "/graphql/reference/objects#reaction", "description": "

An emoji reaction to a particular piece of content.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -53919,6 +54009,7 @@ "id": "reactiongroup", "href": "/graphql/reference/objects#reactiongroup", "description": "

A group of emoji reactions to a particular piece of content.

", + "isDeprecated": false, "fields": [ { "name": "content", @@ -54643,6 +54734,7 @@ "id": "release", "href": "/graphql/reference/objects#release", "description": "

A release contains the content for a release.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -54996,6 +55088,7 @@ "id": "releaseasset", "href": "/graphql/reference/objects#releaseasset", "description": "

A release asset contains the content for a release asset.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -55282,6 +55375,7 @@ "id": "removedfromprojectevent", "href": "/graphql/reference/objects#removedfromprojectevent", "description": "

Represents aremoved_from_projectevent on a given issue or pull request.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -63170,6 +63264,7 @@ "id": "repositorycontactlink", "href": "/graphql/reference/objects#repositorycontactlink", "description": "

A repository contact link.

", + "isDeprecated": false, "fields": [ { "name": "about", @@ -71666,6 +71761,7 @@ "id": "transferredevent", "href": "/graphql/reference/objects#transferredevent", "description": "

Represents atransferredevent on a given issue or pull request.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -72028,6 +72124,7 @@ "id": "unlabeledevent", "href": "/graphql/reference/objects#unlabeledevent", "description": "

Represents anunlabeledevent on a given issue or pull request.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -72178,6 +72275,7 @@ "id": "unpinnedevent", "href": "/graphql/reference/objects#unpinnedevent", "description": "

Represents anunpinnedevent on a given issue or pull request.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -76855,6 +76953,7 @@ "id": "assignable", "href": "/graphql/reference/interfaces#assignable", "description": "

An object that can have users assigned to it.

", + "isDeprecated": false, "fields": [ { "name": "assignedActors", @@ -77132,6 +77231,7 @@ "id": "closable", "href": "/graphql/reference/interfaces#closable", "description": "

An object that can be closed.

", + "isDeprecated": false, "fields": [ { "name": "closed", @@ -77168,6 +77268,7 @@ "id": "comment", "href": "/graphql/reference/interfaces#comment", "description": "

Represents a comment.

", + "isDeprecated": false, "fields": [ { "name": "author", @@ -77542,6 +77643,7 @@ "id": "issuefieldcommon", "href": "/graphql/reference/interfaces#issuefieldcommon", "description": "

Common fields across different issue field types.

", + "isDeprecated": false, "fields": [ { "name": "createdAt", @@ -77585,6 +77687,7 @@ "id": "issuefieldvaluecommon", "href": "/graphql/reference/interfaces#issuefieldvaluecommon", "description": "

Common fields across different issue field value types.

", + "isDeprecated": false, "fields": [ { "name": "field", @@ -77600,6 +77703,7 @@ "id": "labelable", "href": "/graphql/reference/interfaces#labelable", "description": "

An object that can have labels assigned to it.

", + "isDeprecated": false, "fields": [ { "name": "labels", @@ -77669,6 +77773,7 @@ "id": "lockable", "href": "/graphql/reference/interfaces#lockable", "description": "

An object that can be locked.

", + "isDeprecated": false, "fields": [ { "name": "activeLockReason", @@ -78058,6 +78163,7 @@ "id": "pinnable", "href": "/graphql/reference/interfaces#pinnable", "description": "

Entities that can be pinned.

", + "isDeprecated": false, "fields": [ { "name": "isPinned", @@ -78298,6 +78404,7 @@ "id": "projectowner", "href": "/graphql/reference/interfaces#projectowner", "description": "

Represents an owner of a Project.

", + "isDeprecated": false, "fields": [ { "name": "id", @@ -78731,6 +78838,7 @@ "id": "reactable", "href": "/graphql/reference/interfaces#reactable", "description": "

Represents a subject that can be reacted on.

", + "isDeprecated": false, "fields": [ { "name": "databaseId", @@ -80440,6 +80548,7 @@ "id": "updatablecomment", "href": "/graphql/reference/interfaces#updatablecomment", "description": "

Comments that can be updated.

", + "isDeprecated": false, "fields": [ { "name": "viewerCannotUpdateReasons", @@ -80710,6 +80819,7 @@ "id": "commentauthorassociation", "href": "/graphql/reference/enums#commentauthorassociation", "description": "

A comment author association with repository.

", + "isDeprecated": false, "values": [ { "name": "COLLABORATOR", @@ -80750,6 +80860,7 @@ "id": "commentcannotupdatereason", "href": "/graphql/reference/enums#commentcannotupdatereason", "description": "

The possible errors that will prevent a user from updating a comment.

", + "isDeprecated": false, "values": [ { "name": "ARCHIVED", @@ -81914,6 +82025,7 @@ "id": "issueclosedstatereason", "href": "/graphql/reference/enums#issueclosedstatereason", "description": "

The possible state reasons of a closed issue.

", + "isDeprecated": false, "values": [ { "name": "COMPLETED", @@ -81934,6 +82046,7 @@ "id": "issuecommentorderfield", "href": "/graphql/reference/enums#issuecommentorderfield", "description": "

Properties by which issue comment connections can be ordered.

", + "isDeprecated": false, "values": [ { "name": "UPDATED_AT", @@ -81946,6 +82059,7 @@ "id": "issuedependencyorderfield", "href": "/graphql/reference/enums#issuedependencyorderfield", "description": "

Properties by which issue dependencies can be ordered.

", + "isDeprecated": false, "values": [ { "name": "CREATED_AT", @@ -81962,6 +82076,7 @@ "id": "issuefielddatatype", "href": "/graphql/reference/enums#issuefielddatatype", "description": "

The type of an issue field.

", + "isDeprecated": false, "values": [ { "name": "DATE", @@ -81986,6 +82101,7 @@ "id": "issuefieldorderfield", "href": "/graphql/reference/enums#issuefieldorderfield", "description": "

Properties by which issue field connections can be ordered.

", + "isDeprecated": false, "values": [ { "name": "CREATED_AT", @@ -82002,6 +82118,7 @@ "id": "issuefieldsingleselectoptioncolor", "href": "/graphql/reference/enums#issuefieldsingleselectoptioncolor", "description": "

The display color of a single-select field option.

", + "isDeprecated": false, "values": [ { "name": "BLUE", @@ -82042,6 +82159,7 @@ "id": "issuefieldvisibility", "href": "/graphql/reference/enums#issuefieldvisibility", "description": "

The visibility of an issue field.

", + "isDeprecated": false, "values": [ { "name": "ALL", @@ -82058,6 +82176,7 @@ "id": "issueorderfield", "href": "/graphql/reference/enums#issueorderfield", "description": "

Properties by which issue connections can be ordered.

", + "isDeprecated": false, "values": [ { "name": "COMMENTS", @@ -82078,6 +82197,7 @@ "id": "issuesearchtype", "href": "/graphql/reference/enums#issuesearchtype", "description": "

Type of issue search performed.

", + "isDeprecated": false, "values": [ { "name": "HYBRID", @@ -82098,6 +82218,7 @@ "id": "issuestate", "href": "/graphql/reference/enums#issuestate", "description": "

The possible states of an issue.

", + "isDeprecated": false, "values": [ { "name": "CLOSED", @@ -82114,6 +82235,7 @@ "id": "issuestatereason", "href": "/graphql/reference/enums#issuestatereason", "description": "

The possible state reasons of an issue.

", + "isDeprecated": false, "values": [ { "name": "COMPLETED", @@ -82350,6 +82472,7 @@ "id": "issuetypecolor", "href": "/graphql/reference/enums#issuetypecolor", "description": "

The possible color for an issue type.

", + "isDeprecated": false, "values": [ { "name": "BLUE", @@ -82390,6 +82513,7 @@ "id": "issuetypeorderfield", "href": "/graphql/reference/enums#issuetypeorderfield", "description": "

Properties by which issue type connections can be ordered.

", + "isDeprecated": false, "values": [ { "name": "CREATED_AT", @@ -82406,6 +82530,7 @@ "id": "labelorderfield", "href": "/graphql/reference/enums#labelorderfield", "description": "

Properties by which label connections can be ordered.

", + "isDeprecated": false, "values": [ { "name": "CREATED_AT", @@ -82474,6 +82599,7 @@ "id": "lockreason", "href": "/graphql/reference/enums#lockreason", "description": "

The possible reasons that an issue or pull request was locked.

", + "isDeprecated": false, "values": [ { "name": "OFF_TOPIC", @@ -82746,6 +82872,7 @@ "id": "milestoneorderfield", "href": "/graphql/reference/enums#milestoneorderfield", "description": "

Properties by which milestone connections can be ordered.

", + "isDeprecated": false, "values": [ { "name": "CREATED_AT", @@ -82770,6 +82897,7 @@ "id": "milestonestate", "href": "/graphql/reference/enums#milestonestate", "description": "

The possible states of a milestone.

", + "isDeprecated": false, "values": [ { "name": "CLOSED", @@ -83518,6 +83646,7 @@ "id": "projectcardarchivedstate", "href": "/graphql/reference/enums#projectcardarchivedstate", "description": "

The possible archived states of a project card.

", + "isDeprecated": false, "values": [ { "name": "ARCHIVED", @@ -83534,6 +83663,7 @@ "id": "projectcardstate", "href": "/graphql/reference/enums#projectcardstate", "description": "

Various content states of a ProjectCard.

", + "isDeprecated": false, "values": [ { "name": "CONTENT_ONLY", @@ -83554,6 +83684,7 @@ "id": "projectcolumnpurpose", "href": "/graphql/reference/enums#projectcolumnpurpose", "description": "

The semantic purpose of the column - todo, in progress, or done.

", + "isDeprecated": false, "values": [ { "name": "DONE", @@ -83574,6 +83705,7 @@ "id": "projectorderfield", "href": "/graphql/reference/enums#projectorderfield", "description": "

Properties by which project connections can be ordered.

", + "isDeprecated": false, "values": [ { "name": "CREATED_AT", @@ -83594,6 +83726,7 @@ "id": "projectstate", "href": "/graphql/reference/enums#projectstate", "description": "

State of the project; eitheropenor 'closed'.

", + "isDeprecated": false, "values": [ { "name": "CLOSED", @@ -83610,6 +83743,7 @@ "id": "projecttemplate", "href": "/graphql/reference/enums#projecttemplate", "description": "

GitHub-provided templates for Projects.

", + "isDeprecated": false, "values": [ { "name": "AUTOMATED_KANBAN_V2", @@ -84582,6 +84716,7 @@ "id": "reactioncontent", "href": "/graphql/reference/enums#reactioncontent", "description": "

Emojis that can be attached to Issues, Pull Requests and Comments.

", + "isDeprecated": false, "values": [ { "name": "CONFUSED", @@ -84622,6 +84757,7 @@ "id": "reactionorderfield", "href": "/graphql/reference/enums#reactionorderfield", "description": "

A list of fields that reactions can be ordered by.

", + "isDeprecated": false, "values": [ { "name": "CREATED_AT", @@ -84650,6 +84786,7 @@ "id": "releaseorderfield", "href": "/graphql/reference/enums#releaseorderfield", "description": "

Properties by which release connections can be ordered.

", + "isDeprecated": false, "values": [ { "name": "CREATED_AT", @@ -85314,6 +85451,7 @@ "id": "repositorysuggestedactorfilter", "href": "/graphql/reference/enums#repositorysuggestedactorfilter", "description": "

The possible filters for suggested actors in a repository.

", + "isDeprecated": false, "values": [ { "name": "CAN_BE_ASSIGNED", @@ -87346,6 +87484,7 @@ "id": "trackedissuestates", "href": "/graphql/reference/enums#trackedissuestates", "description": "

The possible states of a tracked issue.

", + "isDeprecated": false, "values": [ { "name": "CLOSED", @@ -87496,6 +87635,7 @@ "id": "assignee", "href": "/graphql/reference/unions#assignee", "description": "

Types that can be assigned to issues.

", + "isDeprecated": false, "possibleTypes": [ { "name": "Bot", @@ -87765,6 +87905,7 @@ "id": "issuefieldvalue", "href": "/graphql/reference/unions#issuefieldvalue", "description": "

Issue field values.

", + "isDeprecated": false, "possibleTypes": [ { "name": "IssueFieldDateValue", @@ -87793,6 +87934,7 @@ "id": "issuefields", "href": "/graphql/reference/unions#issuefields", "description": "

Possible issue fields.

", + "isDeprecated": false, "possibleTypes": [ { "name": "IssueFieldDate", @@ -87821,6 +87963,7 @@ "id": "issueorpullrequest", "href": "/graphql/reference/unions#issueorpullrequest", "description": "

Used for return value of Repository.issueOrPullRequest.

", + "isDeprecated": false, "possibleTypes": [ { "name": "Issue", @@ -87839,6 +87982,7 @@ "id": "issuetimelineitem", "href": "/graphql/reference/unions#issuetimelineitem", "description": "

An item in an issue timeline.

", + "isDeprecated": false, "possibleTypes": [ { "name": "AssignedEvent", @@ -87942,6 +88086,7 @@ "id": "issuetimelineitems", "href": "/graphql/reference/unions#issuetimelineitems", "description": "

An item in an issue timeline.

", + "isDeprecated": false, "possibleTypes": [ { "name": "AddedToProjectEvent", @@ -88205,6 +88350,7 @@ "id": "milestoneitem", "href": "/graphql/reference/unions#milestoneitem", "description": "

Types that can be inside a Milestone.

", + "isDeprecated": false, "possibleTypes": [ { "name": "Issue", @@ -88613,6 +88759,7 @@ "id": "projectcarditem", "href": "/graphql/reference/unions#projectcarditem", "description": "

Types that can be inside Project Cards.

", + "isDeprecated": false, "possibleTypes": [ { "name": "Issue", @@ -89385,6 +89532,7 @@ "id": "reactor", "href": "/graphql/reference/unions#reactor", "description": "

Types that can be assigned to reactions.

", + "isDeprecated": false, "possibleTypes": [ { "name": "Bot", @@ -90725,6 +90873,7 @@ "id": "agentassignmentinput", "href": "/graphql/reference/input-objects#agentassignmentinput", "description": "

Represents configuration for assigning Copilot to an issue (public variant).

", + "isDeprecated": false, "inputFields": [ { "name": "baseRef", @@ -95785,6 +95934,7 @@ "id": "issuecommentorder", "href": "/graphql/reference/input-objects#issuecommentorder", "description": "

Ways in which lists of issue comments can be ordered upon return.

", + "isDeprecated": false, "inputFields": [ { "name": "direction", @@ -95807,6 +95957,7 @@ "id": "issuedependencyorder", "href": "/graphql/reference/input-objects#issuedependencyorder", "description": "

Ordering options issue dependencies.

", + "isDeprecated": false, "inputFields": [ { "name": "direction", @@ -95829,6 +95980,7 @@ "id": "issuefieldcreateorupdateinput", "href": "/graphql/reference/input-objects#issuefieldcreateorupdateinput", "description": "

Represents an issue field value that must be set on an issue during issue creation.

", + "isDeprecated": false, "inputFields": [ { "name": "dateValue", @@ -95879,6 +96031,7 @@ "id": "issuefieldorder", "href": "/graphql/reference/input-objects#issuefieldorder", "description": "

Ordering options for issue field connections.

", + "isDeprecated": false, "inputFields": [ { "name": "direction", @@ -95901,6 +96054,7 @@ "id": "issuefieldsingleselectoptioninput", "href": "/graphql/reference/input-objects#issuefieldsingleselectoptioninput", "description": "

A single selection option for an issue field.

", + "isDeprecated": false, "inputFields": [ { "name": "color", @@ -95937,6 +96091,7 @@ "id": "issuefilters", "href": "/graphql/reference/input-objects#issuefilters", "description": "

Ways in which to filter lists of issues.

", + "isDeprecated": false, "inputFields": [ { "name": "assignee", @@ -96015,6 +96170,7 @@ "id": "issueorder", "href": "/graphql/reference/input-objects#issueorder", "description": "

Ways in which lists of issues can be ordered upon return.

", + "isDeprecated": false, "inputFields": [ { "name": "direction", @@ -96037,6 +96193,7 @@ "id": "issuetypeorder", "href": "/graphql/reference/input-objects#issuetypeorder", "description": "

Ordering options for issue types connections.

", + "isDeprecated": false, "inputFields": [ { "name": "direction", @@ -96059,6 +96216,7 @@ "id": "labelorder", "href": "/graphql/reference/input-objects#labelorder", "description": "

Ways in which lists of labels can be ordered upon return.

", + "isDeprecated": false, "inputFields": [ { "name": "direction", @@ -96543,6 +96701,7 @@ "id": "milestoneorder", "href": "/graphql/reference/input-objects#milestoneorder", "description": "

Ordering options for milestone connections.

", + "isDeprecated": false, "inputFields": [ { "name": "direction", @@ -96917,6 +97076,7 @@ "id": "projectcardimport", "href": "/graphql/reference/input-objects#projectcardimport", "description": "

An issue or PR and its owning repository to be used in a project card.

", + "isDeprecated": false, "inputFields": [ { "name": "number", @@ -96939,6 +97099,7 @@ "id": "projectcolumnimport", "href": "/graphql/reference/input-objects#projectcolumnimport", "description": "

A project column and a list of its issues and PRs.

", + "isDeprecated": false, "inputFields": [ { "name": "columnName", @@ -96968,6 +97129,7 @@ "id": "projectorder", "href": "/graphql/reference/input-objects#projectorder", "description": "

Ways in which lists of projects can be ordered upon return.

", + "isDeprecated": false, "inputFields": [ { "name": "direction", @@ -97481,6 +97643,7 @@ "id": "reactionorder", "href": "/graphql/reference/input-objects#reactionorder", "description": "

Ways in which lists of reactions can be ordered upon return.

", + "isDeprecated": false, "inputFields": [ { "name": "direction", @@ -97666,6 +97829,7 @@ "id": "releaseorder", "href": "/graphql/reference/input-objects#releaseorder", "description": "

Ways in which lists of releases can be ordered upon return.

", + "isDeprecated": false, "inputFields": [ { "name": "direction", diff --git a/src/graphql/data/ghec/schema.docs.graphql b/src/graphql/data/ghec/schema.docs.graphql index fb419320748b..e159b7bfa554 100644 --- a/src/graphql/data/ghec/schema.docs.graphql +++ b/src/graphql/data/ghec/schema.docs.graphql @@ -1354,7 +1354,7 @@ type AddedToMergeQueueEvent implements Node { """ Represents a 'added_to_project' event on a given issue or pull request. """ -type AddedToProjectEvent implements Node { +type AddedToProjectEvent implements Node @docsCategory(name: "projects-classic") { """ Identifies the actor who performed the event. """ @@ -1436,7 +1436,7 @@ type AddedToProjectV2Event implements Node & ProjectV2Event { """ Represents configuration for assigning Copilot to an issue (public variant) """ -input AgentAssignmentInput { +input AgentAssignmentInput @docsCategory(name: "users") { """ The base ref/branch for the repository. Defaults to the default branch if not provided. """ @@ -1511,7 +1511,7 @@ type AnnouncementBanner { """ A GitHub App. """ -type App implements Node { +type App implements Node @docsCategory(name: "apps") { """ The client ID of the app. """ @@ -1771,7 +1771,7 @@ type ArchiveRepositoryPayload { """ An object that can have users assigned to it. """ -interface Assignable { +interface Assignable @docsCategory(name: "issues") { """ A list of actors assigned to this object. """ @@ -1892,7 +1892,7 @@ type AssignedEvent implements Node { """ Types that can be assigned to issues. """ -union Assignee = Bot | Mannequin | Organization | User +union Assignee @docsCategory(name: "issues") = Bot | Mannequin | Organization | User """ The connection type for Assignee. @@ -2533,7 +2533,7 @@ type Blob implements GitObject & Node { """ Represents a 'blocked_by_added' event on a given issue. """ -type BlockedByAddedEvent implements Node { +type BlockedByAddedEvent implements Node @docsCategory(name: "issues") { """ Identifies the actor who performed the event. """ @@ -2558,7 +2558,7 @@ type BlockedByAddedEvent implements Node { """ Represents a 'blocked_by_removed' event on a given issue. """ -type BlockedByRemovedEvent implements Node { +type BlockedByRemovedEvent implements Node @docsCategory(name: "issues") { """ Identifies the actor who performed the event. """ @@ -2583,7 +2583,7 @@ type BlockedByRemovedEvent implements Node { """ Represents a 'blocking_added' event on a given issue. """ -type BlockingAddedEvent implements Node { +type BlockingAddedEvent implements Node @docsCategory(name: "issues") { """ Identifies the actor who performed the event. """ @@ -2608,7 +2608,7 @@ type BlockingAddedEvent implements Node { """ Represents a 'blocking_removed' event on a given issue. """ -type BlockingRemovedEvent implements Node { +type BlockingRemovedEvent implements Node @docsCategory(name: "issues") { """ Identifies the actor who performed the event. """ @@ -2633,7 +2633,7 @@ type BlockingRemovedEvent implements Node { """ A special type of user which takes actions on behalf of GitHub Apps. """ -type Bot implements Actor & Node & UniformResourceLocatable { +type Bot implements Actor & Node & UniformResourceLocatable @docsCategory(name: "apps") { """ A URL pointing to the GitHub App's public avatar. """ @@ -4746,7 +4746,7 @@ type CloneTemplateRepositoryPayload { """ An object that can be closed """ -interface Closable { +interface Closable @docsCategory(name: "issues") { """ Indicates if the object is closed (definition of closed may depend on type) """ @@ -5056,7 +5056,7 @@ enum CollaboratorAffiliation { """ Represents a comment. """ -interface Comment { +interface Comment @docsCategory(name: "issues") { """ The actor who authored the comment. """ @@ -5156,7 +5156,7 @@ interface Comment { """ A comment author association with repository. """ -enum CommentAuthorAssociation { +enum CommentAuthorAssociation @docsCategory(name: "issues") { """ Author has been invited to collaborate on the repository. """ @@ -5201,7 +5201,7 @@ enum CommentAuthorAssociation { """ The possible errors that will prevent a user from updating a comment. """ -enum CommentCannotUpdateReason { +enum CommentCannotUpdateReason @docsCategory(name: "issues") { """ Unable to create comment because repository is archived. """ @@ -6519,7 +6519,7 @@ enum ComparisonStatus { """ Represents a 'connected' event on a given issue or pull request. """ -type ConnectedEvent implements Node { +type ConnectedEvent implements Node @docsCategory(name: "issues") { """ Identifies the actor who performed the event. """ @@ -7318,7 +7318,7 @@ type ConvertToDraftEvent implements Node & UniformResourceLocatable { """ Represents a 'converted_from_draft' event on a given issue or pull request. """ -type ConvertedFromDraftEvent implements Node & ProjectV2Event { +type ConvertedFromDraftEvent implements Node & ProjectV2Event @docsCategory(name: "pulls") { """ Identifies the actor who performed the event. """ @@ -11015,7 +11015,7 @@ type DeleteVerifiableDomainPayload { """ Represents a 'demilestoned' event on a given issue or pull request. """ -type DemilestonedEvent implements Node { +type DemilestonedEvent implements Node @docsCategory(name: "issues") { """ Identifies the actor who performed the event. """ @@ -12303,7 +12303,7 @@ type DisablePullRequestAutoMergePayload { """ Represents a 'disconnected' event on a given issue or pull request. """ -type DisconnectedEvent implements Node { +type DisconnectedEvent implements Node @docsCategory(name: "issues") { """ Identifies the actor who performed the event. """ @@ -19146,7 +19146,8 @@ enum IpAllowListUserLevelEnforcementEnabledSettingValue { """ An Issue is a place to discuss ideas, enhancements, tasks, and bugs for a project. """ -type Issue implements Assignable & Closable & Comment & Deletable & Labelable & Lockable & Node & ProjectV2Owner & Reactable & RepositoryNode & Subscribable & SubscribableThread & UniformResourceLocatable & Updatable & UpdatableComment { +type Issue implements Assignable & Closable & Comment & Deletable & Labelable & Lockable & Node & ProjectV2Owner & Reactable & RepositoryNode & Subscribable & SubscribableThread & UniformResourceLocatable & Updatable & UpdatableComment + @docsCategory(name: "issues") { """ Reason that the conversation was locked. """ @@ -20074,7 +20075,7 @@ type Issue implements Assignable & Closable & Comment & Deletable & Labelable & """ The possible state reasons of a closed issue. """ -enum IssueClosedStateReason { +enum IssueClosedStateReason @docsCategory(name: "issues") { """ An issue that has been closed as completed """ @@ -20094,7 +20095,8 @@ enum IssueClosedStateReason { """ Represents a comment on an Issue. """ -type IssueComment implements Comment & Deletable & Minimizable & Node & Pinnable & Reactable & RepositoryNode & Updatable & UpdatableComment { +type IssueComment implements Comment & Deletable & Minimizable & Node & Pinnable & Reactable & RepositoryNode & Updatable & UpdatableComment + @docsCategory(name: "issues") { """ The actor who authored the comment. """ @@ -20378,7 +20380,7 @@ type IssueCommentEdge { """ Ways in which lists of issue comments can be ordered upon return. """ -input IssueCommentOrder { +input IssueCommentOrder @docsCategory(name: "issues") { """ The direction in which to order issue comments by the specified field. """ @@ -20393,7 +20395,7 @@ input IssueCommentOrder { """ Properties by which issue comment connections can be ordered. """ -enum IssueCommentOrderField { +enum IssueCommentOrderField @docsCategory(name: "issues") { """ Order issue comments by update time """ @@ -20403,7 +20405,7 @@ enum IssueCommentOrderField { """ Represents a 'issue_comment_pinned' event on a given issue. """ -type IssueCommentPinnedEvent implements Node { +type IssueCommentPinnedEvent implements Node @docsCategory(name: "issues") { """ Identifies the actor who performed the event. """ @@ -20428,7 +20430,7 @@ type IssueCommentPinnedEvent implements Node { """ Represents a 'issue_comment_unpinned' event on a given issue. """ -type IssueCommentUnpinnedEvent implements Node { +type IssueCommentUnpinnedEvent implements Node @docsCategory(name: "issues") { """ Identifies the actor who performed the event. """ @@ -20478,7 +20480,7 @@ type IssueConnection { """ This aggregates issues opened by a user within one repository. """ -type IssueContributionsByRepository { +type IssueContributionsByRepository @docsCategory(name: "issues") { """ The issue contributions. """ @@ -20518,7 +20520,7 @@ type IssueContributionsByRepository { """ Summary of the state of an issue's dependencies """ -type IssueDependenciesSummary { +type IssueDependenciesSummary @docsCategory(name: "issues") { """ Count of issues this issue is blocked by """ @@ -20543,7 +20545,7 @@ type IssueDependenciesSummary { """ Ordering options issue dependencies """ -input IssueDependencyOrder { +input IssueDependencyOrder @docsCategory(name: "issues") { """ The ordering direction. """ @@ -20558,7 +20560,7 @@ input IssueDependencyOrder { """ Properties by which issue dependencies can be ordered. """ -enum IssueDependencyOrderField { +enum IssueDependencyOrderField @docsCategory(name: "issues") { """ Order issue dependencies by the creation time of the dependent issue """ @@ -20588,7 +20590,7 @@ type IssueEdge { """ Represents a 'issue_field_added' event on a given issue. """ -type IssueFieldAddedEvent implements Node { +type IssueFieldAddedEvent implements Node @docsCategory(name: "issues") { """ Identifies the actor who performed the event. """ @@ -20623,7 +20625,7 @@ type IssueFieldAddedEvent implements Node { """ Represents a 'issue_field_changed' event on a given issue. """ -type IssueFieldChangedEvent implements Node { +type IssueFieldChangedEvent implements Node @docsCategory(name: "issues") { """ Identifies the actor who performed the event. """ @@ -20668,7 +20670,7 @@ type IssueFieldChangedEvent implements Node { """ Common fields across different issue field types """ -interface IssueFieldCommon { +interface IssueFieldCommon @docsCategory(name: "issues") { """ The issue field's creation timestamp. """ @@ -20698,7 +20700,7 @@ interface IssueFieldCommon { """ Represents an issue field value that must be set on an issue during issue creation """ -input IssueFieldCreateOrUpdateInput { +input IssueFieldCreateOrUpdateInput @docsCategory(name: "issues") { """ The date value, for a date field """ @@ -20733,7 +20735,7 @@ input IssueFieldCreateOrUpdateInput { """ The type of an issue field. """ -enum IssueFieldDataType { +enum IssueFieldDataType @docsCategory(name: "issues") { """ Date """ @@ -20758,7 +20760,7 @@ enum IssueFieldDataType { """ Represents a date issue field. """ -type IssueFieldDate implements IssueFieldCommon & Node { +type IssueFieldDate implements IssueFieldCommon & Node @docsCategory(name: "issues") { """ The issue field's creation timestamp. """ @@ -20793,7 +20795,7 @@ type IssueFieldDate implements IssueFieldCommon & Node { """ The value of a date field in an Issue item. """ -type IssueFieldDateValue implements IssueFieldValueCommon & Node { +type IssueFieldDateValue implements IssueFieldValueCommon & Node @docsCategory(name: "issues") { """ The issue field that contains this value. """ @@ -20813,7 +20815,7 @@ type IssueFieldDateValue implements IssueFieldValueCommon & Node { """ Represents a number issue field. """ -type IssueFieldNumber implements IssueFieldCommon & Node { +type IssueFieldNumber implements IssueFieldCommon & Node @docsCategory(name: "issues") { """ The issue field's creation timestamp. """ @@ -20848,7 +20850,7 @@ type IssueFieldNumber implements IssueFieldCommon & Node { """ The value of a number field in an Issue item. """ -type IssueFieldNumberValue implements IssueFieldValueCommon & Node { +type IssueFieldNumberValue implements IssueFieldValueCommon & Node @docsCategory(name: "issues") { """ The issue field that contains this value. """ @@ -20868,7 +20870,7 @@ type IssueFieldNumberValue implements IssueFieldValueCommon & Node { """ Ordering options for issue field connections """ -input IssueFieldOrder { +input IssueFieldOrder @docsCategory(name: "issues") { """ The ordering direction. """ @@ -20883,7 +20885,7 @@ input IssueFieldOrder { """ Properties by which issue field connections can be ordered. """ -enum IssueFieldOrderField { +enum IssueFieldOrderField @docsCategory(name: "issues") { """ Order issue fields by creation time """ @@ -20898,7 +20900,7 @@ enum IssueFieldOrderField { """ Represents a 'issue_field_removed' event on a given issue. """ -type IssueFieldRemovedEvent implements Node { +type IssueFieldRemovedEvent implements Node @docsCategory(name: "issues") { """ Identifies the actor who performed the event. """ @@ -20923,7 +20925,7 @@ type IssueFieldRemovedEvent implements Node { """ Represents a single select issue field. """ -type IssueFieldSingleSelect implements IssueFieldCommon & Node { +type IssueFieldSingleSelect implements IssueFieldCommon & Node @docsCategory(name: "issues") { """ The issue field's creation timestamp. """ @@ -20963,7 +20965,7 @@ type IssueFieldSingleSelect implements IssueFieldCommon & Node { """ Represents an option in a single-select issue field. """ -type IssueFieldSingleSelectOption implements Node { +type IssueFieldSingleSelectOption implements Node @docsCategory(name: "issues") { """ The option's display color. """ @@ -20993,7 +20995,7 @@ type IssueFieldSingleSelectOption implements Node { """ The display color of a single-select field option. """ -enum IssueFieldSingleSelectOptionColor { +enum IssueFieldSingleSelectOptionColor @docsCategory(name: "issues") { """ blue """ @@ -21038,7 +21040,7 @@ enum IssueFieldSingleSelectOptionColor { """ A single selection option for an issue field. """ -input IssueFieldSingleSelectOptionInput { +input IssueFieldSingleSelectOptionInput @docsCategory(name: "issues") { """ The color associated with the option. """ @@ -21063,7 +21065,7 @@ input IssueFieldSingleSelectOptionInput { """ The value of a single select field in an Issue item. """ -type IssueFieldSingleSelectValue implements IssueFieldValueCommon & Node { +type IssueFieldSingleSelectValue implements IssueFieldValueCommon & Node @docsCategory(name: "issues") { """ The option's display color. """ @@ -21103,7 +21105,7 @@ type IssueFieldSingleSelectValue implements IssueFieldValueCommon & Node { """ Represents a text issue field. """ -type IssueFieldText implements IssueFieldCommon & Node { +type IssueFieldText implements IssueFieldCommon & Node @docsCategory(name: "issues") { """ The issue field's creation timestamp. """ @@ -21138,7 +21140,7 @@ type IssueFieldText implements IssueFieldCommon & Node { """ The value of a text field in an Issue item. """ -type IssueFieldTextValue implements IssueFieldValueCommon & Node { +type IssueFieldTextValue implements IssueFieldValueCommon & Node @docsCategory(name: "issues") { """ The issue field that contains this value. """ @@ -21158,12 +21160,16 @@ type IssueFieldTextValue implements IssueFieldValueCommon & Node { """ Issue field values """ -union IssueFieldValue = IssueFieldDateValue | IssueFieldNumberValue | IssueFieldSingleSelectValue | IssueFieldTextValue +union IssueFieldValue @docsCategory(name: "issues") = + | IssueFieldDateValue + | IssueFieldNumberValue + | IssueFieldSingleSelectValue + | IssueFieldTextValue """ Common fields across different issue field value types """ -interface IssueFieldValueCommon { +interface IssueFieldValueCommon @docsCategory(name: "issues") { """ The issue field that contains this value. """ @@ -21213,7 +21219,7 @@ type IssueFieldValueEdge { """ The visibility of an issue field. """ -enum IssueFieldVisibility { +enum IssueFieldVisibility @docsCategory(name: "issues") { """ All """ @@ -21228,7 +21234,11 @@ enum IssueFieldVisibility { """ Possible issue fields. """ -union IssueFields = IssueFieldDate | IssueFieldNumber | IssueFieldSingleSelect | IssueFieldText +union IssueFields @docsCategory(name: "issues") = + | IssueFieldDate + | IssueFieldNumber + | IssueFieldSingleSelect + | IssueFieldText """ The connection type for IssueFields. @@ -21273,7 +21283,7 @@ type IssueFieldsEdge { """ Ways in which to filter lists of issues. """ -input IssueFilters { +input IssueFilters @docsCategory(name: "issues") { """ List issues assigned to given name. Pass in `null` for issues with no assigned user, and `*` for issues assigned to any user. @@ -21333,12 +21343,12 @@ input IssueFilters { """ Used for return value of Repository.issueOrPullRequest. """ -union IssueOrPullRequest = Issue | PullRequest +union IssueOrPullRequest @docsCategory(name: "issues") = Issue | PullRequest """ Ways in which lists of issues can be ordered upon return. """ -input IssueOrder { +input IssueOrder @docsCategory(name: "issues") { """ The direction in which to order issues by the specified field. """ @@ -21353,7 +21363,7 @@ input IssueOrder { """ Properties by which issue connections can be ordered. """ -enum IssueOrderField { +enum IssueOrderField @docsCategory(name: "issues") { """ Order issues by comment count """ @@ -21373,7 +21383,7 @@ enum IssueOrderField { """ Type of issue search performed """ -enum IssueSearchType { +enum IssueSearchType @docsCategory(name: "issues") { """ Hybrid search combining lexical and semantic approaches """ @@ -21393,7 +21403,7 @@ enum IssueSearchType { """ The possible states of an issue. """ -enum IssueState { +enum IssueState @docsCategory(name: "issues") { """ An issue that has been closed """ @@ -21408,7 +21418,7 @@ enum IssueState { """ The possible state reasons of an issue. """ -enum IssueStateReason { +enum IssueStateReason @docsCategory(name: "issues") { """ An issue that has been closed as completed """ @@ -21433,7 +21443,7 @@ enum IssueStateReason { """ A repository issue template. """ -type IssueTemplate { +type IssueTemplate @docsCategory(name: "issues") { """ The template purpose. """ @@ -21548,7 +21558,7 @@ type IssueTimelineConnection { """ An item in an issue timeline """ -union IssueTimelineItem = +union IssueTimelineItem @docsCategory(name: "issues") = | AssignedEvent | ClosedEvent | Commit @@ -21587,7 +21597,7 @@ type IssueTimelineItemEdge { """ An item in an issue timeline """ -union IssueTimelineItems = +union IssueTimelineItems @docsCategory(name: "issues") = | AddedToProjectEvent | AddedToProjectV2Event | AssignedEvent @@ -21958,7 +21968,7 @@ enum IssueTimelineItemsItemType { """ Represents the type of Issue. """ -type IssueType implements Node { +type IssueType implements Node @docsCategory(name: "issues") { """ The issue type's color. """ @@ -22051,7 +22061,7 @@ type IssueType implements Node { """ Represents a 'issue_type_added' event on a given issue. """ -type IssueTypeAddedEvent implements Node { +type IssueTypeAddedEvent implements Node @docsCategory(name: "issues") { """ Identifies the actor who performed the event. """ @@ -22076,7 +22086,7 @@ type IssueTypeAddedEvent implements Node { """ Represents a 'issue_type_changed' event on a given issue. """ -type IssueTypeChangedEvent implements Node { +type IssueTypeChangedEvent implements Node @docsCategory(name: "issues") { """ Identifies the actor who performed the event. """ @@ -22106,7 +22116,7 @@ type IssueTypeChangedEvent implements Node { """ The possible color for an issue type """ -enum IssueTypeColor { +enum IssueTypeColor @docsCategory(name: "issues") { """ blue """ @@ -22191,7 +22201,7 @@ type IssueTypeEdge { """ Ordering options for issue types connections """ -input IssueTypeOrder { +input IssueTypeOrder @docsCategory(name: "issues") { """ The ordering direction. """ @@ -22206,7 +22216,7 @@ input IssueTypeOrder { """ Properties by which issue type connections can be ordered. """ -enum IssueTypeOrderField { +enum IssueTypeOrderField @docsCategory(name: "issues") { """ Order issue types by creation time """ @@ -22221,7 +22231,7 @@ enum IssueTypeOrderField { """ Represents a 'issue_type_removed' event on a given issue. """ -type IssueTypeRemovedEvent implements Node { +type IssueTypeRemovedEvent implements Node @docsCategory(name: "issues") { """ Identifies the actor who performed the event. """ @@ -22278,7 +22288,7 @@ type JoinedGitHubContribution implements Contribution { """ A label for categorizing Issues, Pull Requests, Milestones, or Discussions with a given Repository. """ -type Label implements Node { +type Label implements Node @docsCategory(name: "issues") { """ Identifies the label color. """ @@ -22468,7 +22478,7 @@ type LabelEdge { """ Ways in which lists of labels can be ordered upon return. """ -input LabelOrder { +input LabelOrder @docsCategory(name: "issues") { """ The direction in which to order labels by the specified field. """ @@ -22483,7 +22493,7 @@ input LabelOrder { """ Properties by which label connections can be ordered. """ -enum LabelOrderField { +enum LabelOrderField @docsCategory(name: "issues") { """ Order labels by creation time """ @@ -22503,7 +22513,7 @@ enum LabelOrderField { """ An object that can have labels assigned to it. """ -interface Labelable { +interface Labelable @docsCategory(name: "issues") { """ A list of labels associated with the object. """ @@ -22543,7 +22553,7 @@ interface Labelable { """ Represents a 'labeled' event on a given issue or pull request. """ -type LabeledEvent implements Node { +type LabeledEvent implements Node @docsCategory(name: "issues") { """ Identifies the actor who performed the event. """ @@ -22911,7 +22921,7 @@ type LinkRepositoryToProjectPayload { """ A branch linked to an issue. """ -type LinkedBranch implements Node { +type LinkedBranch implements Node @docsCategory(name: "issues") { """ The Node ID of the LinkedBranch object """ @@ -23006,7 +23016,7 @@ type LockLockablePayload { """ The possible reasons that an issue or pull request was locked. """ -enum LockReason { +enum LockReason @docsCategory(name: "issues") { """ The issue or pull request was locked because the conversation was off-topic. """ @@ -23031,7 +23041,7 @@ enum LockReason { """ An object that can be locked. """ -interface Lockable { +interface Lockable @docsCategory(name: "issues") { """ Reason that the conversation was locked. """ @@ -25158,7 +25168,7 @@ enum MigrationState { """ Represents a Milestone object on a given repository. """ -type Milestone implements Closable & Node & UniformResourceLocatable { +type Milestone implements Closable & Node & UniformResourceLocatable @docsCategory(name: "issues") { """ Indicates if the object is closed (definition of closed may depend on type) """ @@ -25398,12 +25408,12 @@ type MilestoneEdge { """ Types that can be inside a Milestone. """ -union MilestoneItem = Issue | PullRequest +union MilestoneItem @docsCategory(name: "issues") = Issue | PullRequest """ Ordering options for milestone connections. """ -input MilestoneOrder { +input MilestoneOrder @docsCategory(name: "issues") { """ The ordering direction. """ @@ -25418,7 +25428,7 @@ input MilestoneOrder { """ Properties by which milestone connections can be ordered. """ -enum MilestoneOrderField { +enum MilestoneOrderField @docsCategory(name: "issues") { """ Order milestones by when they were created. """ @@ -25443,7 +25453,7 @@ enum MilestoneOrderField { """ The possible states of a milestone. """ -enum MilestoneState { +enum MilestoneState @docsCategory(name: "issues") { """ A milestone that has been closed. """ @@ -25458,7 +25468,7 @@ enum MilestoneState { """ Represents a 'milestoned' event on a given issue or pull request. """ -type MilestonedEvent implements Node { +type MilestonedEvent implements Node @docsCategory(name: "issues") { """ Identifies the actor who performed the event. """ @@ -25637,7 +25647,7 @@ type MoveProjectColumnPayload { """ Represents a 'moved_columns_in_project' event on a given issue or pull request. """ -type MovedColumnsInProjectEvent implements Node { +type MovedColumnsInProjectEvent implements Node @docsCategory(name: "projects-classic") { """ Identifies the actor who performed the event. """ @@ -25766,7 +25776,7 @@ type Mutation { Parameters for AddAssigneesToAssignable """ input: AddAssigneesToAssignableInput! - ): AddAssigneesToAssignablePayload + ): AddAssigneesToAssignablePayload @docsCategory(name: "issues") """ Adds a 'blocked by' relationship to an issue. @@ -25776,7 +25786,7 @@ type Mutation { Parameters for AddBlockedBy """ input: AddBlockedByInput! - ): AddBlockedByPayload + ): AddBlockedByPayload @docsCategory(name: "issues") """ Adds a comment to an Issue or Pull Request. @@ -25836,7 +25846,7 @@ type Mutation { Parameters for AddLabelsToLabelable """ input: AddLabelsToLabelableInput! - ): AddLabelsToLabelablePayload + ): AddLabelsToLabelablePayload @docsCategory(name: "issues") """ Adds a card to a ProjectColumn. Either `contentId` or `note` must be provided but **not** both. @@ -25850,6 +25860,7 @@ type Mutation { @deprecated( reason: "Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC." ) + @docsCategory(name: "projects-classic") """ Adds a column to a Project. @@ -25863,6 +25874,7 @@ type Mutation { @deprecated( reason: "Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC." ) + @docsCategory(name: "projects-classic") """ Creates a new draft issue and add it to a Project. @@ -25932,7 +25944,7 @@ type Mutation { Parameters for AddReaction """ input: AddReactionInput! - ): AddReactionPayload + ): AddReactionPayload @docsCategory(name: "reactions") """ Adds a star to a Starrable. @@ -26073,7 +26085,7 @@ type Mutation { Parameters for ClearLabelsFromLabelable """ input: ClearLabelsFromLabelableInput! - ): ClearLabelsFromLabelablePayload + ): ClearLabelsFromLabelablePayload @docsCategory(name: "issues") """ This mutation clears the value of a field for an item in a Project. Currently @@ -26099,6 +26111,7 @@ type Mutation { @deprecated( reason: "Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC." ) + @docsCategory(name: "projects-classic") """ Create a new repository with the same files and directory structure as a template repository. @@ -26128,7 +26141,7 @@ type Mutation { Parameters for CloseIssue """ input: CloseIssueInput! - ): CloseIssuePayload + ): CloseIssuePayload @docsCategory(name: "issues") """ Close a pull request. @@ -26152,6 +26165,7 @@ type Mutation { @deprecated( reason: "Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC." ) + @docsCategory(name: "projects-classic") """ Converts a projectV2 draft issue item to an issue. @@ -26347,7 +26361,7 @@ type Mutation { Parameters for CreateIssue """ input: CreateIssueInput! - ): CreateIssuePayload + ): CreateIssuePayload @docsCategory(name: "issues") """ Creates a new issue field. @@ -26357,7 +26371,7 @@ type Mutation { Parameters for CreateIssueField """ input: CreateIssueFieldInput! - ): CreateIssueFieldPayload + ): CreateIssueFieldPayload @docsCategory(name: "issues") """ Creates a new issue field value for an issue. @@ -26367,7 +26381,7 @@ type Mutation { Parameters for CreateIssueFieldValue """ input: CreateIssueFieldValueInput! - ): CreateIssueFieldValuePayload + ): CreateIssueFieldValuePayload @docsCategory(name: "issues") """ Creates a new issue type @@ -26377,7 +26391,7 @@ type Mutation { Parameters for CreateIssueType """ input: CreateIssueTypeInput! - ): CreateIssueTypePayload + ): CreateIssueTypePayload @docsCategory(name: "issues") """ Creates a new label. @@ -26387,7 +26401,7 @@ type Mutation { Parameters for CreateLabel """ input: CreateLabelInput! - ): CreateLabelPayload + ): CreateLabelPayload @docsCategory(name: "issues") """ Create a branch linked to an issue. @@ -26397,7 +26411,7 @@ type Mutation { Parameters for CreateLinkedBranch """ input: CreateLinkedBranchInput! - ): CreateLinkedBranchPayload + ): CreateLinkedBranchPayload @docsCategory(name: "issues") """ Creates a GitHub Enterprise Importer (GEI) migration source. @@ -26421,6 +26435,7 @@ type Mutation { @deprecated( reason: "Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC." ) + @docsCategory(name: "projects-classic") """ Creates a new project. @@ -26641,7 +26656,7 @@ type Mutation { Parameters for DeleteIssue """ input: DeleteIssueInput! - ): DeleteIssuePayload + ): DeleteIssuePayload @docsCategory(name: "issues") """ Deletes an IssueComment object. @@ -26651,7 +26666,7 @@ type Mutation { Parameters for DeleteIssueComment """ input: DeleteIssueCommentInput! - ): DeleteIssueCommentPayload + ): DeleteIssueCommentPayload @docsCategory(name: "issues") """ Deletes an issue field. @@ -26661,7 +26676,7 @@ type Mutation { Parameters for DeleteIssueField """ input: DeleteIssueFieldInput! - ): DeleteIssueFieldPayload + ): DeleteIssueFieldPayload @docsCategory(name: "issues") """ Deletes an issue field value from an issue. @@ -26671,7 +26686,7 @@ type Mutation { Parameters for DeleteIssueFieldValue """ input: DeleteIssueFieldValueInput! - ): DeleteIssueFieldValuePayload + ): DeleteIssueFieldValuePayload @docsCategory(name: "issues") """ Delete an issue type @@ -26681,7 +26696,7 @@ type Mutation { Parameters for DeleteIssueType """ input: DeleteIssueTypeInput! - ): DeleteIssueTypePayload + ): DeleteIssueTypePayload @docsCategory(name: "issues") """ Deletes a label. @@ -26691,7 +26706,7 @@ type Mutation { Parameters for DeleteLabel """ input: DeleteLabelInput! - ): DeleteLabelPayload + ): DeleteLabelPayload @docsCategory(name: "issues") """ Unlink a branch from an issue. @@ -26701,7 +26716,7 @@ type Mutation { Parameters for DeleteLinkedBranch """ input: DeleteLinkedBranchInput! - ): DeleteLinkedBranchPayload + ): DeleteLinkedBranchPayload @docsCategory(name: "issues") """ Delete a package version. @@ -26725,6 +26740,7 @@ type Mutation { @deprecated( reason: "Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC." ) + @docsCategory(name: "projects-classic") """ Deletes a project card. @@ -26738,6 +26754,7 @@ type Mutation { @deprecated( reason: "Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC." ) + @docsCategory(name: "projects-classic") """ Deletes a project column. @@ -26751,6 +26768,7 @@ type Mutation { @deprecated( reason: "Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC." ) + @docsCategory(name: "projects-classic") """ Delete a project. @@ -26984,6 +27002,7 @@ type Mutation { @deprecated( reason: "Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC." ) + @docsCategory(name: "migrations") """ Invite someone to become an administrator of the enterprise. @@ -27037,6 +27056,7 @@ type Mutation { @deprecated( reason: "Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC." ) + @docsCategory(name: "projects-classic") """ Lock a lockable object @@ -27046,7 +27066,7 @@ type Mutation { Parameters for LockLockable """ input: LockLockableInput! - ): LockLockablePayload + ): LockLockablePayload @docsCategory(name: "issues") """ Mark a discussion comment as the chosen answer for discussions in an answerable category. @@ -27130,6 +27150,7 @@ type Mutation { @deprecated( reason: "Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC." ) + @docsCategory(name: "projects-classic") """ Moves a project column to another place. @@ -27143,6 +27164,7 @@ type Mutation { @deprecated( reason: "Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC." ) + @docsCategory(name: "projects-classic") """ Pin an environment to a repository @@ -27162,7 +27184,7 @@ type Mutation { Parameters for PinIssue """ input: PinIssueInput! - ): PinIssuePayload + ): PinIssuePayload @docsCategory(name: "issues") """ Pins an Issue Comment. @@ -27172,7 +27194,7 @@ type Mutation { Parameters for PinIssueComment """ input: PinIssueCommentInput! - ): PinIssueCommentPayload + ): PinIssueCommentPayload @docsCategory(name: "issues") """ Promote a repository custom property to the enterprise level. @@ -27232,7 +27254,7 @@ type Mutation { Parameters for RemoveAssigneesFromAssignable """ input: RemoveAssigneesFromAssignableInput! - ): RemoveAssigneesFromAssignablePayload + ): RemoveAssigneesFromAssignablePayload @docsCategory(name: "issues") """ Removes a 'blocked by' relationship from an issue. @@ -27242,7 +27264,7 @@ type Mutation { Parameters for RemoveBlockedBy """ input: RemoveBlockedByInput! - ): RemoveBlockedByPayload + ): RemoveBlockedByPayload @docsCategory(name: "issues") """ Removes an administrator from the enterprise. @@ -27303,7 +27325,7 @@ type Mutation { Parameters for RemoveLabelsFromLabelable """ input: RemoveLabelsFromLabelableInput! - ): RemoveLabelsFromLabelablePayload + ): RemoveLabelsFromLabelablePayload @docsCategory(name: "issues") """ Removes outside collaborator from all repositories in an organization. @@ -27323,7 +27345,7 @@ type Mutation { Parameters for RemoveReaction """ input: RemoveReactionInput! - ): RemoveReactionPayload + ): RemoveReactionPayload @docsCategory(name: "reactions") """ Removes a star from a Starrable. @@ -27373,7 +27395,7 @@ type Mutation { Parameters for ReopenIssue """ input: ReopenIssueInput! - ): ReopenIssuePayload + ): ReopenIssuePayload @docsCategory(name: "issues") """ Reopen a pull request. @@ -27383,7 +27405,7 @@ type Mutation { Parameters for ReopenPullRequest """ input: ReopenPullRequestInput! - ): ReopenPullRequestPayload + ): ReopenPullRequestPayload @docsCategory(name: "pulls") """ Reorder a pinned repository environment @@ -27403,7 +27425,7 @@ type Mutation { Parameters for ReplaceActorsForAssignable """ input: ReplaceActorsForAssignableInput! - ): ReplaceActorsForAssignablePayload + ): ReplaceActorsForAssignablePayload @docsCategory(name: "issues") """ Reprioritizes a sub-issue to a different position in the parent list. @@ -27513,7 +27535,7 @@ type Mutation { Parameters for SetIssueFieldValue """ input: SetIssueFieldValueInput! - ): SetIssueFieldValuePayload + ): SetIssueFieldValuePayload @docsCategory(name: "issues") """ Set an organization level interaction limit for an organization's public repositories. @@ -27603,7 +27625,7 @@ type Mutation { Parameters for TransferIssue """ input: TransferIssueInput! - ): TransferIssuePayload + ): TransferIssuePayload @docsCategory(name: "issues") """ Unarchives a ProjectV2Item @@ -27689,6 +27711,7 @@ type Mutation { @deprecated( reason: "Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC." ) + @docsCategory(name: "projects-classic") """ Unlock a lockable object @@ -27698,7 +27721,7 @@ type Mutation { Parameters for UnlockLockable """ input: UnlockLockableInput! - ): UnlockLockablePayload + ): UnlockLockablePayload @docsCategory(name: "issues") """ Unmark a discussion comment as the chosen answer for discussions in an answerable category. @@ -27728,7 +27751,7 @@ type Mutation { Parameters for UnmarkIssueAsDuplicate """ input: UnmarkIssueAsDuplicateInput! - ): UnmarkIssueAsDuplicatePayload + ): UnmarkIssueAsDuplicatePayload @docsCategory(name: "issues") """ Unmark a project as a template. @@ -27758,7 +27781,7 @@ type Mutation { Parameters for UnpinIssue """ input: UnpinIssueInput! - ): UnpinIssuePayload + ): UnpinIssuePayload @docsCategory(name: "issues") """ Unpins an Issue Comment. @@ -27768,7 +27791,7 @@ type Mutation { Parameters for UnpinIssueComment """ input: UnpinIssueCommentInput! - ): UnpinIssueCommentPayload + ): UnpinIssueCommentPayload @docsCategory(name: "issues") """ Marks a review thread as unresolved. @@ -27898,7 +27921,7 @@ type Mutation { Parameters for UpdateEnterpriseMembersCanDeleteIssuesSetting """ input: UpdateEnterpriseMembersCanDeleteIssuesSettingInput! - ): UpdateEnterpriseMembersCanDeleteIssuesSettingPayload + ): UpdateEnterpriseMembersCanDeleteIssuesSettingPayload @docsCategory(name: "enterprise-admin") """ Sets the members can delete repositories setting for an enterprise. @@ -28068,7 +28091,7 @@ type Mutation { Parameters for UpdateIssue """ input: UpdateIssueInput! - ): UpdateIssuePayload + ): UpdateIssuePayload @docsCategory(name: "issues") """ Updates an IssueComment object. @@ -28078,7 +28101,7 @@ type Mutation { Parameters for UpdateIssueComment """ input: UpdateIssueCommentInput! - ): UpdateIssueCommentPayload + ): UpdateIssueCommentPayload @docsCategory(name: "issues") """ Updates an issue field. @@ -28088,7 +28111,7 @@ type Mutation { Parameters for UpdateIssueField """ input: UpdateIssueFieldInput! - ): UpdateIssueFieldPayload + ): UpdateIssueFieldPayload @docsCategory(name: "issues") """ Updates an existing issue field value for an issue. @@ -28098,7 +28121,7 @@ type Mutation { Parameters for UpdateIssueFieldValue """ input: UpdateIssueFieldValueInput! - ): UpdateIssueFieldValuePayload + ): UpdateIssueFieldValuePayload @docsCategory(name: "issues") """ Updates the issue type on an issue @@ -28108,7 +28131,7 @@ type Mutation { Parameters for UpdateIssueIssueType """ input: UpdateIssueIssueTypeInput! - ): UpdateIssueIssueTypePayload + ): UpdateIssueIssueTypePayload @docsCategory(name: "issues") """ Update an issue type @@ -28118,7 +28141,7 @@ type Mutation { Parameters for UpdateIssueType """ input: UpdateIssueTypeInput! - ): UpdateIssueTypePayload + ): UpdateIssueTypePayload @docsCategory(name: "issues") """ Updates an existing label. @@ -28128,7 +28151,7 @@ type Mutation { Parameters for UpdateLabel """ input: UpdateLabelInput! - ): UpdateLabelPayload + ): UpdateLabelPayload @docsCategory(name: "issues") """ Update the setting to restrict notifications to only verified or approved domains available to an owner. @@ -28185,6 +28208,7 @@ type Mutation { @deprecated( reason: "Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC." ) + @docsCategory(name: "projects-classic") """ Updates an existing project card. @@ -28198,6 +28222,7 @@ type Mutation { @deprecated( reason: "Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC." ) + @docsCategory(name: "projects-classic") """ Updates an existing project column. @@ -28211,6 +28236,7 @@ type Mutation { @deprecated( reason: "Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC." ) + @docsCategory(name: "projects-classic") """ Updates an existing project. @@ -36944,7 +36970,7 @@ type PinIssuePayload { """ Entities that can be pinned. """ -interface Pinnable { +interface Pinnable @docsCategory(name: "users") { """ Indicates whether or not this entity is currently pinned. """ @@ -37349,7 +37375,7 @@ type PinnedEvent implements Node { """ A Pinned Issue is a issue pinned to a repository's index page. """ -type PinnedIssue implements Node { +type PinnedIssue implements Node @docsCategory(name: "issues") { """ Identifies the primary key from the database. """ @@ -37384,7 +37410,7 @@ type PinnedIssue implements Node { """ A comment pinned to an Issue. """ -type PinnedIssueComment implements Node { +type PinnedIssueComment implements Node @docsCategory(name: "issues") { """ Identifies the primary key from the database. """ @@ -37990,7 +38016,7 @@ interface ProfileOwner { """ Projects manage issues, pull requests and notes within a project owner. """ -type Project implements Closable & Node & Updatable { +type Project implements Closable & Node & Updatable @docsCategory(name: "projects-classic") { """ The project's description body. """ @@ -38193,7 +38219,7 @@ type Project implements Closable & Node & Updatable { """ A card in a project. """ -type ProjectCard implements Node { +type ProjectCard implements Node @docsCategory(name: "projects-classic") { """ The project column this card is associated under. A card may only belong to one project column at a time. The column field will be null if the card is created @@ -38305,7 +38331,7 @@ type ProjectCard implements Node { """ The possible archived states of a project card. """ -enum ProjectCardArchivedState { +enum ProjectCardArchivedState @docsCategory(name: "projects-classic") { """ A project card that is archived """ @@ -38366,7 +38392,7 @@ type ProjectCardEdge { """ An issue or PR and its owning repository to be used in a project card. """ -input ProjectCardImport { +input ProjectCardImport @docsCategory(name: "projects-classic") { """ The issue or pull request number. """ @@ -38381,12 +38407,12 @@ input ProjectCardImport { """ Types that can be inside Project Cards. """ -union ProjectCardItem = Issue | PullRequest +union ProjectCardItem @docsCategory(name: "projects-classic") = Issue | PullRequest """ Various content states of a ProjectCard """ -enum ProjectCardState { +enum ProjectCardState @docsCategory(name: "projects-classic") { """ The card has content only. """ @@ -38406,7 +38432,7 @@ enum ProjectCardState { """ A column inside a project. """ -type ProjectColumn implements Node { +type ProjectColumn implements Node @docsCategory(name: "projects-classic") { """ List of cards in the column """ @@ -38556,7 +38582,7 @@ type ProjectColumnEdge { """ A project column and a list of its issues and PRs. """ -input ProjectColumnImport { +input ProjectColumnImport @docsCategory(name: "projects-classic") { """ The name of the column. """ @@ -38576,7 +38602,7 @@ input ProjectColumnImport { """ The semantic purpose of the column - todo, in progress, or done. """ -enum ProjectColumnPurpose { +enum ProjectColumnPurpose @docsCategory(name: "projects-classic") { """ The column contains cards which are complete """ @@ -38636,7 +38662,7 @@ type ProjectEdge { """ Ways in which lists of projects can be ordered upon return. """ -input ProjectOrder { +input ProjectOrder @docsCategory(name: "projects-classic") { """ The direction in which to order projects by the specified field. """ @@ -38651,7 +38677,7 @@ input ProjectOrder { """ Properties by which project connections can be ordered. """ -enum ProjectOrderField { +enum ProjectOrderField @docsCategory(name: "projects-classic") { """ Order projects by creation time """ @@ -38671,7 +38697,7 @@ enum ProjectOrderField { """ Represents an owner of a Project. """ -interface ProjectOwner { +interface ProjectOwner @docsCategory(name: "projects-classic") { """ The Node ID of the ProjectOwner object """ @@ -38764,7 +38790,7 @@ interface ProjectOwner { """ Project progress stats. """ -type ProjectProgress { +type ProjectProgress @docsCategory(name: "projects-classic") { """ The number of done cards. """ @@ -38825,7 +38851,7 @@ type ProjectProgress { """ State of the project; either 'open' or 'closed' """ -enum ProjectState { +enum ProjectState @docsCategory(name: "projects-classic") { """ The project is closed. """ @@ -38840,7 +38866,7 @@ enum ProjectState { """ GitHub-provided templates for Projects """ -enum ProjectTemplate { +enum ProjectTemplate @docsCategory(name: "projects-classic") { """ Create a board with v2 triggers to automatically move cards across To do, In progress and Done columns. """ @@ -46062,7 +46088,7 @@ type RateLimit { """ Represents a subject that can be reacted on. """ -interface Reactable { +interface Reactable @docsCategory(name: "reactions") { """ Identifies the primary key from the database. """ @@ -46163,7 +46189,7 @@ type ReactingUserEdge { """ An emoji reaction to a particular piece of content. """ -type Reaction implements Node { +type Reaction implements Node @docsCategory(name: "reactions") { """ Identifies the emoji reaction. """ @@ -46228,7 +46254,7 @@ type ReactionConnection { """ Emojis that can be attached to Issues, Pull Requests and Comments. """ -enum ReactionContent { +enum ReactionContent @docsCategory(name: "reactions") { """ Represents the `:confused:` emoji. """ @@ -46288,7 +46314,7 @@ type ReactionEdge { """ A group of emoji reactions to a particular piece of content. """ -type ReactionGroup { +type ReactionGroup @docsCategory(name: "reactions") { """ Identifies the emoji reaction. """ @@ -46366,7 +46392,7 @@ type ReactionGroup { """ Ways in which lists of reactions can be ordered upon return. """ -input ReactionOrder { +input ReactionOrder @docsCategory(name: "reactions") { """ The direction in which to order reactions by the specified field. """ @@ -46381,7 +46407,7 @@ input ReactionOrder { """ A list of fields that reactions can be ordered by. """ -enum ReactionOrderField { +enum ReactionOrderField @docsCategory(name: "reactions") { """ Allows ordering a list of reactions by when they were created. """ @@ -46391,7 +46417,7 @@ enum ReactionOrderField { """ Types that can be assigned to reactions. """ -union Reactor = Bot | Mannequin | Organization | User +union Reactor @docsCategory(name: "reactions") = Bot | Mannequin | Organization | User """ The connection type for Reactor. @@ -46950,7 +46976,7 @@ type RejectDeploymentsPayload { """ A release contains the content for a release. """ -type Release implements Node & Reactable & UniformResourceLocatable { +type Release implements Node & Reactable & UniformResourceLocatable @docsCategory(name: "releases") { """ The author of the release """ @@ -47160,7 +47186,7 @@ type Release implements Node & Reactable & UniformResourceLocatable { """ A release asset contains the content for a release asset. """ -type ReleaseAsset implements Node { +type ReleaseAsset implements Node @docsCategory(name: "releases") { """ The asset's content-type """ @@ -47305,7 +47331,7 @@ type ReleaseEdge { """ Ways in which lists of releases can be ordered upon return. """ -input ReleaseOrder { +input ReleaseOrder @docsCategory(name: "releases") { """ The direction in which to order releases by the specified field. """ @@ -47320,7 +47346,7 @@ input ReleaseOrder { """ Properties by which release connections can be ordered. """ -enum ReleaseOrderField { +enum ReleaseOrderField @docsCategory(name: "releases") { """ Order releases by creation time """ @@ -47893,7 +47919,7 @@ type RemovedFromMergeQueueEvent implements Node { """ Represents a 'removed_from_project' event on a given issue or pull request. """ -type RemovedFromProjectEvent implements Node { +type RemovedFromProjectEvent implements Node @docsCategory(name: "projects-classic") { """ Identifies the actor who performed the event. """ @@ -53683,7 +53709,7 @@ type RepositoryConnection { """ A repository contact link. """ -type RepositoryContactLink { +type RepositoryContactLink @docsCategory(name: "repos") { """ The contact link purpose. """ @@ -55590,7 +55616,7 @@ enum RepositoryRulesetTarget { """ The possible filters for suggested actors in a repository """ -enum RepositorySuggestedActorFilter { +enum RepositorySuggestedActorFilter @docsCategory(name: "repos") { """ Actors that can be assigned to issues and pull requests """ @@ -64668,7 +64694,7 @@ enum TopicSuggestionDeclineReason { """ The possible states of a tracked issue. """ -enum TrackedIssueStates { +enum TrackedIssueStates @docsCategory(name: "issues") { """ The tracked issue is closed """ @@ -64758,7 +64784,7 @@ type TransferIssuePayload { """ Represents a 'transferred' event on a given issue or pull request. """ -type TransferredEvent implements Node { +type TransferredEvent implements Node @docsCategory(name: "issues") { """ Identifies the actor who performed the event. """ @@ -65185,7 +65211,7 @@ type UnknownSignature implements GitSignature { """ Represents an 'unlabeled' event on a given issue or pull request. """ -type UnlabeledEvent implements Node { +type UnlabeledEvent implements Node @docsCategory(name: "issues") { """ Identifies the actor who performed the event. """ @@ -65656,7 +65682,7 @@ type UnpinIssuePayload { """ Represents an 'unpinned' event on a given issue or pull request. """ -type UnpinnedEvent implements Node { +type UnpinnedEvent implements Node @docsCategory(name: "issues") { """ Identifies the actor who performed the event. """ @@ -65746,7 +65772,7 @@ interface Updatable { """ Comments that can be updated. """ -interface UpdatableComment { +interface UpdatableComment @docsCategory(name: "issues") { """ Reasons why the current viewer can not update this comment. """ diff --git a/src/graphql/data/ghec/schema.json b/src/graphql/data/ghec/schema.json index 3b44fc3b3059..8512f967a29d 100644 --- a/src/graphql/data/ghec/schema.json +++ b/src/graphql/data/ghec/schema.json @@ -1027,6 +1027,7 @@ "id": "addassigneestoassignable", "href": "/graphql/reference/mutations#addassigneestoassignable", "description": "

Adds assignees to an assignable object.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -1057,6 +1058,7 @@ "id": "addblockedby", "href": "/graphql/reference/mutations#addblockedby", "description": "

Adds a 'blocked by' relationship to an issue.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -1258,6 +1260,7 @@ "id": "addlabelstolabelable", "href": "/graphql/reference/mutations#addlabelstolabelable", "description": "

Adds labels to a labelable object.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -1560,6 +1563,7 @@ "id": "addreaction", "href": "/graphql/reference/mutations#addreaction", "description": "

Adds a reaction to a subject.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -2015,6 +2019,7 @@ "id": "clearlabelsfromlabelable", "href": "/graphql/reference/mutations#clearlabelsfromlabelable", "description": "

Clears all labels from a labelable object.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -2174,6 +2179,7 @@ "id": "closeissue", "href": "/graphql/reference/mutations#closeissue", "description": "

Close an issue.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -2721,6 +2727,7 @@ "id": "createissue", "href": "/graphql/reference/mutations#createissue", "description": "

Creates a new issue.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -2751,6 +2758,7 @@ "id": "createissuefield", "href": "/graphql/reference/mutations#createissuefield", "description": "

Creates a new issue field.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -2781,6 +2789,7 @@ "id": "createissuefieldvalue", "href": "/graphql/reference/mutations#createissuefieldvalue", "description": "

Creates a new issue field value for an issue.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -2818,6 +2827,7 @@ "id": "createissuetype", "href": "/graphql/reference/mutations#createissuetype", "description": "

Creates a new issue type.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -2848,6 +2858,7 @@ "id": "createlabel", "href": "/graphql/reference/mutations#createlabel", "description": "

Creates a new label.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -2878,6 +2889,7 @@ "id": "createlinkedbranch", "href": "/graphql/reference/mutations#createlinkedbranch", "description": "

Create a branch linked to an issue.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -3595,6 +3607,7 @@ "id": "deleteissue", "href": "/graphql/reference/mutations#deleteissue", "description": "

Deletes an Issue object.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -3625,6 +3638,7 @@ "id": "deleteissuecomment", "href": "/graphql/reference/mutations#deleteissuecomment", "description": "

Deletes an IssueComment object.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -3648,6 +3662,7 @@ "id": "deleteissuefield", "href": "/graphql/reference/mutations#deleteissuefield", "description": "

Deletes an issue field.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -3678,6 +3693,7 @@ "id": "deleteissuefieldvalue", "href": "/graphql/reference/mutations#deleteissuefieldvalue", "description": "

Deletes an issue field value from an issue.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -3715,6 +3731,7 @@ "id": "deleteissuetype", "href": "/graphql/reference/mutations#deleteissuetype", "description": "

Delete an issue type.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -3745,6 +3762,7 @@ "id": "deletelabel", "href": "/graphql/reference/mutations#deletelabel", "description": "

Deletes a label.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -3768,6 +3786,7 @@ "id": "deletelinkedbranch", "href": "/graphql/reference/mutations#deletelinkedbranch", "description": "

Unlink a branch from an issue.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -4810,6 +4829,7 @@ "id": "locklockable", "href": "/graphql/reference/mutations#locklockable", "description": "

Lock a lockable object.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -5165,6 +5185,7 @@ "id": "pinissue", "href": "/graphql/reference/mutations#pinissue", "description": "

Pin an issue to a repository.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -5195,6 +5216,7 @@ "id": "pinissuecomment", "href": "/graphql/reference/mutations#pinissuecomment", "description": "

Pins an Issue Comment.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -5375,6 +5397,7 @@ "id": "removeassigneesfromassignable", "href": "/graphql/reference/mutations#removeassigneesfromassignable", "description": "

Removes assignees from an assignable object.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -5405,6 +5428,7 @@ "id": "removeblockedby", "href": "/graphql/reference/mutations#removeblockedby", "description": "

Removes a 'blocked by' relationship from an issue.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -5641,6 +5665,7 @@ "id": "removelabelsfromlabelable", "href": "/graphql/reference/mutations#removelabelsfromlabelable", "description": "

Removes labels from a Labelable object.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -5701,6 +5726,7 @@ "id": "removereaction", "href": "/graphql/reference/mutations#removereaction", "description": "

Removes a reaction from a subject.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -5872,6 +5898,7 @@ "id": "reopenissue", "href": "/graphql/reference/mutations#reopenissue", "description": "

Reopen a issue.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -5902,6 +5929,7 @@ "id": "reopenpullrequest", "href": "/graphql/reference/mutations#reopenpullrequest", "description": "

Reopen a pull request.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -5962,6 +5990,7 @@ "id": "replaceactorsforassignable", "href": "/graphql/reference/mutations#replaceactorsforassignable", "description": "

Replaces all actors for assignable object.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -6327,6 +6356,7 @@ "id": "setissuefieldvalue", "href": "/graphql/reference/mutations#setissuefieldvalue", "description": "

Sets the value of an IssueFieldValue.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -6604,6 +6634,7 @@ "id": "transferissue", "href": "/graphql/reference/mutations#transferissue", "description": "

Transfer an issue to a different repository.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -6883,6 +6914,7 @@ "id": "unlocklockable", "href": "/graphql/reference/mutations#unlocklockable", "description": "

Unlock a lockable object.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -6980,6 +7012,7 @@ "id": "unmarkissueasduplicate", "href": "/graphql/reference/mutations#unmarkissueasduplicate", "description": "

Unmark an issue as a duplicate of another issue.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -7070,6 +7103,7 @@ "id": "unpinissue", "href": "/graphql/reference/mutations#unpinissue", "description": "

Unpin a pinned issue from a repository.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -7107,6 +7141,7 @@ "id": "unpinissuecomment", "href": "/graphql/reference/mutations#unpinissuecomment", "description": "

Unpins an Issue Comment.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -7532,6 +7567,7 @@ "id": "updateenterprisememberscandeleteissuessetting", "href": "/graphql/reference/mutations#updateenterprisememberscandeleteissuessetting", "description": "

Sets the members can delete issues setting for an enterprise.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -8112,6 +8148,7 @@ "id": "updateissue", "href": "/graphql/reference/mutations#updateissue", "description": "

Updates an Issue.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -8149,6 +8186,7 @@ "id": "updateissuecomment", "href": "/graphql/reference/mutations#updateissuecomment", "description": "

Updates an IssueComment object.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -8179,6 +8217,7 @@ "id": "updateissuefield", "href": "/graphql/reference/mutations#updateissuefield", "description": "

Updates an issue field.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -8209,6 +8248,7 @@ "id": "updateissuefieldvalue", "href": "/graphql/reference/mutations#updateissuefieldvalue", "description": "

Updates an existing issue field value for an issue.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -8246,6 +8286,7 @@ "id": "updateissueissuetype", "href": "/graphql/reference/mutations#updateissueissuetype", "description": "

Updates the issue type on an issue.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -8276,6 +8317,7 @@ "id": "updateissuetype", "href": "/graphql/reference/mutations#updateissuetype", "description": "

Update an issue type.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -8306,6 +8348,7 @@ "id": "updatelabel", "href": "/graphql/reference/mutations#updatelabel", "description": "

Updates an existing label.

", + "isDeprecated": false, "inputFields": [ { "name": "input", @@ -9511,6 +9554,7 @@ "id": "addedtoprojectevent", "href": "/graphql/reference/objects#addedtoprojectevent", "description": "

Represents aadded_to_projectevent on a given issue or pull request.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -9674,6 +9718,7 @@ "id": "app", "href": "/graphql/reference/objects#app", "description": "

A GitHub App.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -10652,6 +10697,7 @@ "id": "blockedbyaddedevent", "href": "/graphql/reference/objects#blockedbyaddedevent", "description": "

Represents ablocked_by_addedevent on a given issue.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -10695,6 +10741,7 @@ "id": "blockedbyremovedevent", "href": "/graphql/reference/objects#blockedbyremovedevent", "description": "

Represents ablocked_by_removedevent on a given issue.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -10738,6 +10785,7 @@ "id": "blockingaddedevent", "href": "/graphql/reference/objects#blockingaddedevent", "description": "

Represents ablocking_addedevent on a given issue.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -10781,6 +10829,7 @@ "id": "blockingremovedevent", "href": "/graphql/reference/objects#blockingremovedevent", "description": "

Represents ablocking_removedevent on a given issue.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -10824,6 +10873,7 @@ "id": "bot", "href": "/graphql/reference/objects#bot", "description": "

A special type of user which takes actions on behalf of GitHub Apps.

", + "isDeprecated": false, "implements": [ { "name": "Actor", @@ -14811,6 +14861,7 @@ "id": "connectedevent", "href": "/graphql/reference/objects#connectedevent", "description": "

Represents aconnectedevent on a given issue or pull request.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -15803,6 +15854,7 @@ "id": "convertedfromdraftevent", "href": "/graphql/reference/objects#convertedfromdraftevent", "description": "

Represents aconverted_from_draftevent on a given issue or pull request.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -16735,6 +16787,7 @@ "id": "demilestonedevent", "href": "/graphql/reference/objects#demilestonedevent", "description": "

Represents ademilestonedevent on a given issue or pull request.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -18246,6 +18299,7 @@ "id": "disconnectedevent", "href": "/graphql/reference/objects#disconnectedevent", "description": "

Represents adisconnectedevent on a given issue or pull request.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -26345,6 +26399,7 @@ "id": "issue", "href": "/graphql/reference/objects#issue", "description": "

An Issue is a place to discuss ideas, enhancements, tasks, and bugs for a project.

", + "isDeprecated": false, "implements": [ { "name": "Assignable", @@ -27986,6 +28041,7 @@ "id": "issuecomment", "href": "/graphql/reference/objects#issuecomment", "description": "

Represents a comment on an Issue.

", + "isDeprecated": false, "implements": [ { "name": "Comment", @@ -28452,6 +28508,7 @@ "id": "issuecommentpinnedevent", "href": "/graphql/reference/objects#issuecommentpinnedevent", "description": "

Represents aissue_comment_pinnedevent on a given issue.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -28495,6 +28552,7 @@ "id": "issuecommentunpinnedevent", "href": "/graphql/reference/objects#issuecommentunpinnedevent", "description": "

Represents aissue_comment_unpinnedevent on a given issue.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -28574,6 +28632,7 @@ "id": "issuecontributionsbyrepository", "href": "/graphql/reference/objects#issuecontributionsbyrepository", "description": "

This aggregates issues opened by a user within one repository.

", + "isDeprecated": false, "fields": [ { "name": "contributions", @@ -28643,6 +28702,7 @@ "id": "issuedependenciessummary", "href": "/graphql/reference/objects#issuedependenciessummary", "description": "

Summary of the state of an issue's dependencies.

", + "isDeprecated": false, "fields": [ { "name": "blockedBy", @@ -28701,6 +28761,7 @@ "id": "issuefieldaddedevent", "href": "/graphql/reference/objects#issuefieldaddedevent", "description": "

Represents aissue_field_addedevent on a given issue.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -28758,6 +28819,7 @@ "id": "issuefieldchangedevent", "href": "/graphql/reference/objects#issuefieldchangedevent", "description": "

Represents aissue_field_changedevent on a given issue.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -28829,6 +28891,7 @@ "id": "issuefielddate", "href": "/graphql/reference/objects#issuefielddate", "description": "

Represents a date issue field.

", + "isDeprecated": false, "implements": [ { "name": "IssueFieldCommon", @@ -28891,6 +28954,7 @@ "id": "issuefielddatevalue", "href": "/graphql/reference/objects#issuefielddatevalue", "description": "

The value of a date field in an Issue item.

", + "isDeprecated": false, "implements": [ { "name": "IssueFieldValueCommon", @@ -28932,6 +28996,7 @@ "id": "issuefieldnumber", "href": "/graphql/reference/objects#issuefieldnumber", "description": "

Represents a number issue field.

", + "isDeprecated": false, "implements": [ { "name": "IssueFieldCommon", @@ -28994,6 +29059,7 @@ "id": "issuefieldnumbervalue", "href": "/graphql/reference/objects#issuefieldnumbervalue", "description": "

The value of a number field in an Issue item.

", + "isDeprecated": false, "implements": [ { "name": "IssueFieldValueCommon", @@ -29035,6 +29101,7 @@ "id": "issuefieldremovedevent", "href": "/graphql/reference/objects#issuefieldremovedevent", "description": "

Represents aissue_field_removedevent on a given issue.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -29078,6 +29145,7 @@ "id": "issuefieldsingleselect", "href": "/graphql/reference/objects#issuefieldsingleselect", "description": "

Represents a single select issue field.

", + "isDeprecated": false, "implements": [ { "name": "IssueFieldCommon", @@ -29147,6 +29215,7 @@ "id": "issuefieldsingleselectoption", "href": "/graphql/reference/objects#issuefieldsingleselectoption", "description": "

Represents an option in a single-select issue field.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -29197,6 +29266,7 @@ "id": "issuefieldsingleselectvalue", "href": "/graphql/reference/objects#issuefieldsingleselectvalue", "description": "

The value of a single select field in an Issue item.

", + "isDeprecated": false, "implements": [ { "name": "IssueFieldValueCommon", @@ -29266,6 +29336,7 @@ "id": "issuefieldtext", "href": "/graphql/reference/objects#issuefieldtext", "description": "

Represents a text issue field.

", + "isDeprecated": false, "implements": [ { "name": "IssueFieldCommon", @@ -29328,6 +29399,7 @@ "id": "issuefieldtextvalue", "href": "/graphql/reference/objects#issuefieldtextvalue", "description": "

The value of a text field in an Issue item.

", + "isDeprecated": false, "implements": [ { "name": "IssueFieldValueCommon", @@ -29485,6 +29557,7 @@ "id": "issuetemplate", "href": "/graphql/reference/objects#issuetemplate", "description": "

A repository issue template.

", + "isDeprecated": false, "fields": [ { "name": "about", @@ -29771,6 +29844,7 @@ "id": "issuetype", "href": "/graphql/reference/objects#issuetype", "description": "

Represents the type of Issue.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -29927,6 +30001,7 @@ "id": "issuetypeaddedevent", "href": "/graphql/reference/objects#issuetypeaddedevent", "description": "

Represents aissue_type_addedevent on a given issue.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -29970,6 +30045,7 @@ "id": "issuetypechangedevent", "href": "/graphql/reference/objects#issuetypechangedevent", "description": "

Represents aissue_type_changedevent on a given issue.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -30078,6 +30154,7 @@ "id": "issuetyperemovedevent", "href": "/graphql/reference/objects#issuetyperemovedevent", "description": "

Represents aissue_type_removedevent on a given issue.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -30171,6 +30248,7 @@ "id": "label", "href": "/graphql/reference/objects#label", "description": "

A label for categorizing Issues, Pull Requests, Milestones, or Discussions with a given Repository.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -30485,6 +30563,7 @@ "id": "labeledevent", "href": "/graphql/reference/objects#labeledevent", "description": "

Represents alabeledevent on a given issue or pull request.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -30792,6 +30871,7 @@ "id": "linkedbranch", "href": "/graphql/reference/objects#linkedbranch", "description": "

A branch linked to an issue.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -32960,6 +33040,7 @@ "id": "milestone", "href": "/graphql/reference/objects#milestone", "description": "

Represents a Milestone object on a given repository.

", + "isDeprecated": false, "implements": [ { "name": "Closable", @@ -33354,6 +33435,7 @@ "id": "milestonedevent", "href": "/graphql/reference/objects#milestonedevent", "description": "

Represents amilestonedevent on a given issue or pull request.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -33404,6 +33486,7 @@ "id": "movedcolumnsinprojectevent", "href": "/graphql/reference/objects#movedcolumnsinprojectevent", "description": "

Represents amoved_columns_in_projectevent on a given issue or pull request.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -44312,6 +44395,7 @@ "id": "pinnedissue", "href": "/graphql/reference/objects#pinnedissue", "description": "

A Pinned Issue is a issue pinned to a repository's index page.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -44369,6 +44453,7 @@ "id": "pinnedissuecomment", "href": "/graphql/reference/objects#pinnedissuecomment", "description": "

A comment pinned to an Issue.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -45039,6 +45124,7 @@ "id": "project", "href": "/graphql/reference/objects#project", "description": "

Projects manage issues, pull requests and notes within a project owner.

", + "isDeprecated": false, "implements": [ { "name": "Closable", @@ -45328,6 +45414,7 @@ "id": "projectcard", "href": "/graphql/reference/objects#projectcard", "description": "

A card in a project.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -45518,6 +45605,7 @@ "id": "projectcolumn", "href": "/graphql/reference/objects#projectcolumn", "description": "

A column inside a project.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -45786,6 +45874,7 @@ "id": "projectprogress", "href": "/graphql/reference/objects#projectprogress", "description": "

Project progress stats.

", + "isDeprecated": false, "fields": [ { "name": "doneCount", @@ -53797,6 +53886,7 @@ "id": "reaction", "href": "/graphql/reference/objects#reaction", "description": "

An emoji reaction to a particular piece of content.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -53919,6 +54009,7 @@ "id": "reactiongroup", "href": "/graphql/reference/objects#reactiongroup", "description": "

A group of emoji reactions to a particular piece of content.

", + "isDeprecated": false, "fields": [ { "name": "content", @@ -54643,6 +54734,7 @@ "id": "release", "href": "/graphql/reference/objects#release", "description": "

A release contains the content for a release.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -54996,6 +55088,7 @@ "id": "releaseasset", "href": "/graphql/reference/objects#releaseasset", "description": "

A release asset contains the content for a release asset.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -55282,6 +55375,7 @@ "id": "removedfromprojectevent", "href": "/graphql/reference/objects#removedfromprojectevent", "description": "

Represents aremoved_from_projectevent on a given issue or pull request.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -63170,6 +63264,7 @@ "id": "repositorycontactlink", "href": "/graphql/reference/objects#repositorycontactlink", "description": "

A repository contact link.

", + "isDeprecated": false, "fields": [ { "name": "about", @@ -71666,6 +71761,7 @@ "id": "transferredevent", "href": "/graphql/reference/objects#transferredevent", "description": "

Represents atransferredevent on a given issue or pull request.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -72028,6 +72124,7 @@ "id": "unlabeledevent", "href": "/graphql/reference/objects#unlabeledevent", "description": "

Represents anunlabeledevent on a given issue or pull request.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -72178,6 +72275,7 @@ "id": "unpinnedevent", "href": "/graphql/reference/objects#unpinnedevent", "description": "

Represents anunpinnedevent on a given issue or pull request.

", + "isDeprecated": false, "implements": [ { "name": "Node", @@ -76855,6 +76953,7 @@ "id": "assignable", "href": "/graphql/reference/interfaces#assignable", "description": "

An object that can have users assigned to it.

", + "isDeprecated": false, "fields": [ { "name": "assignedActors", @@ -77132,6 +77231,7 @@ "id": "closable", "href": "/graphql/reference/interfaces#closable", "description": "

An object that can be closed.

", + "isDeprecated": false, "fields": [ { "name": "closed", @@ -77168,6 +77268,7 @@ "id": "comment", "href": "/graphql/reference/interfaces#comment", "description": "

Represents a comment.

", + "isDeprecated": false, "fields": [ { "name": "author", @@ -77542,6 +77643,7 @@ "id": "issuefieldcommon", "href": "/graphql/reference/interfaces#issuefieldcommon", "description": "

Common fields across different issue field types.

", + "isDeprecated": false, "fields": [ { "name": "createdAt", @@ -77585,6 +77687,7 @@ "id": "issuefieldvaluecommon", "href": "/graphql/reference/interfaces#issuefieldvaluecommon", "description": "

Common fields across different issue field value types.

", + "isDeprecated": false, "fields": [ { "name": "field", @@ -77600,6 +77703,7 @@ "id": "labelable", "href": "/graphql/reference/interfaces#labelable", "description": "

An object that can have labels assigned to it.

", + "isDeprecated": false, "fields": [ { "name": "labels", @@ -77669,6 +77773,7 @@ "id": "lockable", "href": "/graphql/reference/interfaces#lockable", "description": "

An object that can be locked.

", + "isDeprecated": false, "fields": [ { "name": "activeLockReason", @@ -78058,6 +78163,7 @@ "id": "pinnable", "href": "/graphql/reference/interfaces#pinnable", "description": "

Entities that can be pinned.

", + "isDeprecated": false, "fields": [ { "name": "isPinned", @@ -78298,6 +78404,7 @@ "id": "projectowner", "href": "/graphql/reference/interfaces#projectowner", "description": "

Represents an owner of a Project.

", + "isDeprecated": false, "fields": [ { "name": "id", @@ -78731,6 +78838,7 @@ "id": "reactable", "href": "/graphql/reference/interfaces#reactable", "description": "

Represents a subject that can be reacted on.

", + "isDeprecated": false, "fields": [ { "name": "databaseId", @@ -80440,6 +80548,7 @@ "id": "updatablecomment", "href": "/graphql/reference/interfaces#updatablecomment", "description": "

Comments that can be updated.

", + "isDeprecated": false, "fields": [ { "name": "viewerCannotUpdateReasons", @@ -80710,6 +80819,7 @@ "id": "commentauthorassociation", "href": "/graphql/reference/enums#commentauthorassociation", "description": "

A comment author association with repository.

", + "isDeprecated": false, "values": [ { "name": "COLLABORATOR", @@ -80750,6 +80860,7 @@ "id": "commentcannotupdatereason", "href": "/graphql/reference/enums#commentcannotupdatereason", "description": "

The possible errors that will prevent a user from updating a comment.

", + "isDeprecated": false, "values": [ { "name": "ARCHIVED", @@ -81914,6 +82025,7 @@ "id": "issueclosedstatereason", "href": "/graphql/reference/enums#issueclosedstatereason", "description": "

The possible state reasons of a closed issue.

", + "isDeprecated": false, "values": [ { "name": "COMPLETED", @@ -81934,6 +82046,7 @@ "id": "issuecommentorderfield", "href": "/graphql/reference/enums#issuecommentorderfield", "description": "

Properties by which issue comment connections can be ordered.

", + "isDeprecated": false, "values": [ { "name": "UPDATED_AT", @@ -81946,6 +82059,7 @@ "id": "issuedependencyorderfield", "href": "/graphql/reference/enums#issuedependencyorderfield", "description": "

Properties by which issue dependencies can be ordered.

", + "isDeprecated": false, "values": [ { "name": "CREATED_AT", @@ -81962,6 +82076,7 @@ "id": "issuefielddatatype", "href": "/graphql/reference/enums#issuefielddatatype", "description": "

The type of an issue field.

", + "isDeprecated": false, "values": [ { "name": "DATE", @@ -81986,6 +82101,7 @@ "id": "issuefieldorderfield", "href": "/graphql/reference/enums#issuefieldorderfield", "description": "

Properties by which issue field connections can be ordered.

", + "isDeprecated": false, "values": [ { "name": "CREATED_AT", @@ -82002,6 +82118,7 @@ "id": "issuefieldsingleselectoptioncolor", "href": "/graphql/reference/enums#issuefieldsingleselectoptioncolor", "description": "

The display color of a single-select field option.

", + "isDeprecated": false, "values": [ { "name": "BLUE", @@ -82042,6 +82159,7 @@ "id": "issuefieldvisibility", "href": "/graphql/reference/enums#issuefieldvisibility", "description": "

The visibility of an issue field.

", + "isDeprecated": false, "values": [ { "name": "ALL", @@ -82058,6 +82176,7 @@ "id": "issueorderfield", "href": "/graphql/reference/enums#issueorderfield", "description": "

Properties by which issue connections can be ordered.

", + "isDeprecated": false, "values": [ { "name": "COMMENTS", @@ -82078,6 +82197,7 @@ "id": "issuesearchtype", "href": "/graphql/reference/enums#issuesearchtype", "description": "

Type of issue search performed.

", + "isDeprecated": false, "values": [ { "name": "HYBRID", @@ -82098,6 +82218,7 @@ "id": "issuestate", "href": "/graphql/reference/enums#issuestate", "description": "

The possible states of an issue.

", + "isDeprecated": false, "values": [ { "name": "CLOSED", @@ -82114,6 +82235,7 @@ "id": "issuestatereason", "href": "/graphql/reference/enums#issuestatereason", "description": "

The possible state reasons of an issue.

", + "isDeprecated": false, "values": [ { "name": "COMPLETED", @@ -82350,6 +82472,7 @@ "id": "issuetypecolor", "href": "/graphql/reference/enums#issuetypecolor", "description": "

The possible color for an issue type.

", + "isDeprecated": false, "values": [ { "name": "BLUE", @@ -82390,6 +82513,7 @@ "id": "issuetypeorderfield", "href": "/graphql/reference/enums#issuetypeorderfield", "description": "

Properties by which issue type connections can be ordered.

", + "isDeprecated": false, "values": [ { "name": "CREATED_AT", @@ -82406,6 +82530,7 @@ "id": "labelorderfield", "href": "/graphql/reference/enums#labelorderfield", "description": "

Properties by which label connections can be ordered.

", + "isDeprecated": false, "values": [ { "name": "CREATED_AT", @@ -82474,6 +82599,7 @@ "id": "lockreason", "href": "/graphql/reference/enums#lockreason", "description": "

The possible reasons that an issue or pull request was locked.

", + "isDeprecated": false, "values": [ { "name": "OFF_TOPIC", @@ -82746,6 +82872,7 @@ "id": "milestoneorderfield", "href": "/graphql/reference/enums#milestoneorderfield", "description": "

Properties by which milestone connections can be ordered.

", + "isDeprecated": false, "values": [ { "name": "CREATED_AT", @@ -82770,6 +82897,7 @@ "id": "milestonestate", "href": "/graphql/reference/enums#milestonestate", "description": "

The possible states of a milestone.

", + "isDeprecated": false, "values": [ { "name": "CLOSED", @@ -83518,6 +83646,7 @@ "id": "projectcardarchivedstate", "href": "/graphql/reference/enums#projectcardarchivedstate", "description": "

The possible archived states of a project card.

", + "isDeprecated": false, "values": [ { "name": "ARCHIVED", @@ -83534,6 +83663,7 @@ "id": "projectcardstate", "href": "/graphql/reference/enums#projectcardstate", "description": "

Various content states of a ProjectCard.

", + "isDeprecated": false, "values": [ { "name": "CONTENT_ONLY", @@ -83554,6 +83684,7 @@ "id": "projectcolumnpurpose", "href": "/graphql/reference/enums#projectcolumnpurpose", "description": "

The semantic purpose of the column - todo, in progress, or done.

", + "isDeprecated": false, "values": [ { "name": "DONE", @@ -83574,6 +83705,7 @@ "id": "projectorderfield", "href": "/graphql/reference/enums#projectorderfield", "description": "

Properties by which project connections can be ordered.

", + "isDeprecated": false, "values": [ { "name": "CREATED_AT", @@ -83594,6 +83726,7 @@ "id": "projectstate", "href": "/graphql/reference/enums#projectstate", "description": "

State of the project; eitheropenor 'closed'.

", + "isDeprecated": false, "values": [ { "name": "CLOSED", @@ -83610,6 +83743,7 @@ "id": "projecttemplate", "href": "/graphql/reference/enums#projecttemplate", "description": "

GitHub-provided templates for Projects.

", + "isDeprecated": false, "values": [ { "name": "AUTOMATED_KANBAN_V2", @@ -84582,6 +84716,7 @@ "id": "reactioncontent", "href": "/graphql/reference/enums#reactioncontent", "description": "

Emojis that can be attached to Issues, Pull Requests and Comments.

", + "isDeprecated": false, "values": [ { "name": "CONFUSED", @@ -84622,6 +84757,7 @@ "id": "reactionorderfield", "href": "/graphql/reference/enums#reactionorderfield", "description": "

A list of fields that reactions can be ordered by.

", + "isDeprecated": false, "values": [ { "name": "CREATED_AT", @@ -84650,6 +84786,7 @@ "id": "releaseorderfield", "href": "/graphql/reference/enums#releaseorderfield", "description": "

Properties by which release connections can be ordered.

", + "isDeprecated": false, "values": [ { "name": "CREATED_AT", @@ -85314,6 +85451,7 @@ "id": "repositorysuggestedactorfilter", "href": "/graphql/reference/enums#repositorysuggestedactorfilter", "description": "

The possible filters for suggested actors in a repository.

", + "isDeprecated": false, "values": [ { "name": "CAN_BE_ASSIGNED", @@ -87346,6 +87484,7 @@ "id": "trackedissuestates", "href": "/graphql/reference/enums#trackedissuestates", "description": "

The possible states of a tracked issue.

", + "isDeprecated": false, "values": [ { "name": "CLOSED", @@ -87496,6 +87635,7 @@ "id": "assignee", "href": "/graphql/reference/unions#assignee", "description": "

Types that can be assigned to issues.

", + "isDeprecated": false, "possibleTypes": [ { "name": "Bot", @@ -87765,6 +87905,7 @@ "id": "issuefieldvalue", "href": "/graphql/reference/unions#issuefieldvalue", "description": "

Issue field values.

", + "isDeprecated": false, "possibleTypes": [ { "name": "IssueFieldDateValue", @@ -87793,6 +87934,7 @@ "id": "issuefields", "href": "/graphql/reference/unions#issuefields", "description": "

Possible issue fields.

", + "isDeprecated": false, "possibleTypes": [ { "name": "IssueFieldDate", @@ -87821,6 +87963,7 @@ "id": "issueorpullrequest", "href": "/graphql/reference/unions#issueorpullrequest", "description": "

Used for return value of Repository.issueOrPullRequest.

", + "isDeprecated": false, "possibleTypes": [ { "name": "Issue", @@ -87839,6 +87982,7 @@ "id": "issuetimelineitem", "href": "/graphql/reference/unions#issuetimelineitem", "description": "

An item in an issue timeline.

", + "isDeprecated": false, "possibleTypes": [ { "name": "AssignedEvent", @@ -87942,6 +88086,7 @@ "id": "issuetimelineitems", "href": "/graphql/reference/unions#issuetimelineitems", "description": "

An item in an issue timeline.

", + "isDeprecated": false, "possibleTypes": [ { "name": "AddedToProjectEvent", @@ -88205,6 +88350,7 @@ "id": "milestoneitem", "href": "/graphql/reference/unions#milestoneitem", "description": "

Types that can be inside a Milestone.

", + "isDeprecated": false, "possibleTypes": [ { "name": "Issue", @@ -88613,6 +88759,7 @@ "id": "projectcarditem", "href": "/graphql/reference/unions#projectcarditem", "description": "

Types that can be inside Project Cards.

", + "isDeprecated": false, "possibleTypes": [ { "name": "Issue", @@ -89385,6 +89532,7 @@ "id": "reactor", "href": "/graphql/reference/unions#reactor", "description": "

Types that can be assigned to reactions.

", + "isDeprecated": false, "possibleTypes": [ { "name": "Bot", @@ -90725,6 +90873,7 @@ "id": "agentassignmentinput", "href": "/graphql/reference/input-objects#agentassignmentinput", "description": "

Represents configuration for assigning Copilot to an issue (public variant).

", + "isDeprecated": false, "inputFields": [ { "name": "baseRef", @@ -95785,6 +95934,7 @@ "id": "issuecommentorder", "href": "/graphql/reference/input-objects#issuecommentorder", "description": "

Ways in which lists of issue comments can be ordered upon return.

", + "isDeprecated": false, "inputFields": [ { "name": "direction", @@ -95807,6 +95957,7 @@ "id": "issuedependencyorder", "href": "/graphql/reference/input-objects#issuedependencyorder", "description": "

Ordering options issue dependencies.

", + "isDeprecated": false, "inputFields": [ { "name": "direction", @@ -95829,6 +95980,7 @@ "id": "issuefieldcreateorupdateinput", "href": "/graphql/reference/input-objects#issuefieldcreateorupdateinput", "description": "

Represents an issue field value that must be set on an issue during issue creation.

", + "isDeprecated": false, "inputFields": [ { "name": "dateValue", @@ -95879,6 +96031,7 @@ "id": "issuefieldorder", "href": "/graphql/reference/input-objects#issuefieldorder", "description": "

Ordering options for issue field connections.

", + "isDeprecated": false, "inputFields": [ { "name": "direction", @@ -95901,6 +96054,7 @@ "id": "issuefieldsingleselectoptioninput", "href": "/graphql/reference/input-objects#issuefieldsingleselectoptioninput", "description": "

A single selection option for an issue field.

", + "isDeprecated": false, "inputFields": [ { "name": "color", @@ -95937,6 +96091,7 @@ "id": "issuefilters", "href": "/graphql/reference/input-objects#issuefilters", "description": "

Ways in which to filter lists of issues.

", + "isDeprecated": false, "inputFields": [ { "name": "assignee", @@ -96015,6 +96170,7 @@ "id": "issueorder", "href": "/graphql/reference/input-objects#issueorder", "description": "

Ways in which lists of issues can be ordered upon return.

", + "isDeprecated": false, "inputFields": [ { "name": "direction", @@ -96037,6 +96193,7 @@ "id": "issuetypeorder", "href": "/graphql/reference/input-objects#issuetypeorder", "description": "

Ordering options for issue types connections.

", + "isDeprecated": false, "inputFields": [ { "name": "direction", @@ -96059,6 +96216,7 @@ "id": "labelorder", "href": "/graphql/reference/input-objects#labelorder", "description": "

Ways in which lists of labels can be ordered upon return.

", + "isDeprecated": false, "inputFields": [ { "name": "direction", @@ -96543,6 +96701,7 @@ "id": "milestoneorder", "href": "/graphql/reference/input-objects#milestoneorder", "description": "

Ordering options for milestone connections.

", + "isDeprecated": false, "inputFields": [ { "name": "direction", @@ -96917,6 +97076,7 @@ "id": "projectcardimport", "href": "/graphql/reference/input-objects#projectcardimport", "description": "

An issue or PR and its owning repository to be used in a project card.

", + "isDeprecated": false, "inputFields": [ { "name": "number", @@ -96939,6 +97099,7 @@ "id": "projectcolumnimport", "href": "/graphql/reference/input-objects#projectcolumnimport", "description": "

A project column and a list of its issues and PRs.

", + "isDeprecated": false, "inputFields": [ { "name": "columnName", @@ -96968,6 +97129,7 @@ "id": "projectorder", "href": "/graphql/reference/input-objects#projectorder", "description": "

Ways in which lists of projects can be ordered upon return.

", + "isDeprecated": false, "inputFields": [ { "name": "direction", @@ -97481,6 +97643,7 @@ "id": "reactionorder", "href": "/graphql/reference/input-objects#reactionorder", "description": "

Ways in which lists of reactions can be ordered upon return.

", + "isDeprecated": false, "inputFields": [ { "name": "direction", @@ -97666,6 +97829,7 @@ "id": "releaseorder", "href": "/graphql/reference/input-objects#releaseorder", "description": "

Ways in which lists of releases can be ordered upon return.

", + "isDeprecated": false, "inputFields": [ { "name": "direction", diff --git a/src/journeys/lib/journey-path-resolver.ts b/src/journeys/lib/journey-path-resolver.ts index 847966cf16fd..848e6194f09a 100644 --- a/src/journeys/lib/journey-path-resolver.ts +++ b/src/journeys/lib/journey-path-resolver.ts @@ -34,6 +34,7 @@ export interface JourneyTrack { id: string title: string description?: string + timeCommitment?: string guides: Array<{ href: string title: string @@ -50,6 +51,7 @@ type JourneyPage = { id: string title: string description?: string + timeCommitment?: string guides: Array<{ href: string alternativeNextStep?: string @@ -329,6 +331,11 @@ export async function resolveJourneyTracks( ? await renderContent(track.description, context, { textOnly: true }) : track.description + const renderedTimeCommitment = + track.timeCommitment && needsRendering(track.timeCommitment) + ? await renderContent(track.timeCommitment, context, { textOnly: true }) + : track.timeCommitment + const guides = ( await Promise.all( track.guides.map(async (guide: { href: string; alternativeNextStep?: string }) => { @@ -346,6 +353,7 @@ export async function resolveJourneyTracks( id: track.id, title: renderedTitle, description: renderedDescription, + timeCommitment: renderedTimeCommitment, guides, } }), diff --git a/src/journeys/tests/journey-path-resolver.ts b/src/journeys/tests/journey-path-resolver.ts index b9effe317146..f77f6d22e4b2 100644 --- a/src/journeys/tests/journey-path-resolver.ts +++ b/src/journeys/tests/journey-path-resolver.ts @@ -22,8 +22,15 @@ vi.mock('@/journeys/lib/get-link-data', () => ({ const mockGetLinkData = vi.mocked(getLinkData) +const mockRenderContent = vi.fn(async (content: string, _context?: unknown, _options?: unknown) => { + void _context + void _options + return content +}) + vi.mock('@/content-render/index', () => ({ - renderContent: async (content: string) => content, + renderContent: (content: string, context?: unknown, options?: unknown) => + mockRenderContent(content, context, options), })) vi.mock('@/languages/lib/render-with-fallback', () => ({ @@ -204,6 +211,7 @@ describe('journey-path-resolver', () => { id: 'getting_started', title: 'Getting started with {% data variables.product.company_short %}', description: 'Learn the {% data variables.product.company_short %} basics', + timeCommitment: '{% data variables.product.company_short %} 2-4 hours', guides: [ { href: '/enterprise-onboarding/setup' }, { href: '/enterprise-onboarding/config' }, @@ -213,6 +221,7 @@ describe('journey-path-resolver', () => { id: 'advanced', title: 'Advanced configuration', description: 'Advanced topics for experts', + timeCommitment: '4-6 hours', guides: [{ href: '/enterprise-onboarding/advanced-setup' }], }, ] @@ -237,6 +246,27 @@ describe('journey-path-resolver', () => { ) }) + test('propagates timeCommitment and renders Liquid with textOnly like title/description', async () => { + mockRenderContent.mockClear() + const result = await resolveJourneyTracks(mockJourneyTracks, mockContext) + + // Liquid value passes through the (passthrough) renderer; plain string is unchanged + expect(result[0].timeCommitment).toBe('{% data variables.product.company_short %} 2-4 hours') + expect(result[1].timeCommitment).toBe('4-6 hours') + + // The Liquid-bearing timeCommitment should be rendered with { textOnly: true }, + // matching how title/description are rendered. + const timeCommitmentCall = mockRenderContent.mock.calls.find( + ([content]) => content === '{% data variables.product.company_short %} 2-4 hours', + ) + expect(timeCommitmentCall).toBeDefined() + expect(timeCommitmentCall?.[2]).toEqual({ textOnly: true }) + + // Plain (non-Liquid) timeCommitment should not be sent through renderContent + const plainCall = mockRenderContent.mock.calls.find(([content]) => content === '4-6 hours') + expect(plainCall).toBeUndefined() + }) + test('resolves guide links with proper versioning', async () => { const result = await resolveJourneyTracks(mockJourneyTracks, mockContext) @@ -275,6 +305,7 @@ describe('journey-path-resolver', () => { const result = await resolveJourneyTracks(trackWithoutDescription, mockContext) expect(result[0].description).toBeUndefined() + expect(result[0].timeCommitment).toBeUndefined() }) }) diff --git a/src/landings/components/journey/JourneyLearningTracks.tsx b/src/landings/components/journey/JourneyLearningTracks.tsx index 2808360b491b..b7a6a0eb09f0 100644 --- a/src/landings/components/journey/JourneyLearningTracks.tsx +++ b/src/landings/components/journey/JourneyLearningTracks.tsx @@ -31,7 +31,8 @@ export const JourneyLearningTracks = ({ tracks, articlesHeading }: JourneyLearni

{track.title}

- + + {track.timeCommitment && }

{track.description}