diff --git a/CHANGELOG.md b/CHANGELOG.md index 86f49428b401..cfe7e21b5986 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,14 @@ # Docs changelog +**13 April 2026** + +To coincide with the release of the ability to [steer your Copilot CLI sessions remotely](https://github.blog/changelog/2026-04-13-remote-control-cli-sessions-on-web-and-mobile-in-public-preview/) (from GitHub.com, or from GitHub Mobile), we have added these new articles: + +* _Conceptual information:_ [About remote access to GitHub Copilot CLI sessions](https://docs.github.com/copilot/concepts/agents/copilot-cli/about-remote-access) +* _How-to information:_ [Steering a GitHub Copilot CLI session from another device](https://docs.github.com/copilot/how-tos/copilot-cli/steer-remotely) + +
+ **9 April 2026** We've added a conceptual article to the Copilot CLI documentation explaining the context window, compaction, and checkpoints. diff --git a/content/code-security/concepts/code-scanning/about-code-scanning-alerts.md b/content/code-security/concepts/code-scanning/about-code-scanning-alerts.md index 4f983ad28020..0e8f949a7bf7 100644 --- a/content/code-security/concepts/code-scanning/about-code-scanning-alerts.md +++ b/content/code-security/concepts/code-scanning/about-code-scanning-alerts.md @@ -68,6 +68,8 @@ If you configure {% data variables.product.prodname_code_scanning %} using {% da When {% data variables.product.prodname_code_scanning %} reports data-flow alerts, {% data variables.product.prodname_dotcom %} shows you how data moves through the code. {% data variables.product.prodname_code_scanning_caps %} allows you to identify the areas of your code that leak sensitive information, and that could be the entry point for attacks by malicious users. +{% data reusables.code-scanning.track-alert-in-issue %} + ### About alerts from multiple configurations You can run multiple configurations of code analysis on a repository, using different tools and targeting different languages or areas of the code. Each configuration of {% data variables.product.prodname_code_scanning %} generates a unique set of alerts. For example, an alert generated using the default {% data variables.product.prodname_codeql %} analysis with {% data variables.product.prodname_actions %} comes from a different configuration than an alert generated externally and uploaded via the {% data variables.product.prodname_code_scanning %} API. diff --git a/content/code-security/concepts/code-scanning/code-scanning-alert-tracking-using-issues.md b/content/code-security/concepts/code-scanning/code-scanning-alert-tracking-using-issues.md new file mode 100644 index 000000000000..9d276d285f98 --- /dev/null +++ b/content/code-security/concepts/code-scanning/code-scanning-alert-tracking-using-issues.md @@ -0,0 +1,39 @@ +--- +title: Code scanning alert tracking using issues +shortTitle: Alert tracking with issues +intro: Connect security findings to your team's workflow by linking {% data variables.product.prodname_code_scanning %} alerts to issues for tracking and collaboration. +permissions: People with write access for the repository can link {% data variables.product.prodname_code_scanning %} alerts to issues. +versions: + feature: code-scanning-link-alert-to-issue +contentType: concepts +category: + - Find and fix code vulnerabilities +--- + +{% data reusables.code-scanning.alert-tracking-with-issues-preview-note %} + +{% data reusables.code-scanning.enterprise-enable-code-scanning %} + +## How alert-to-issue linking works + +When {% data variables.product.prodname_code_scanning %} identifies a vulnerability in your code, you can link the alert to a {% data variables.product.prodname_dotcom %} **issue** to track remediation work. This brings security fixes into your existing planning and project management workflow, making vulnerabilities visible in sprint planning, project boards, and team backlogs. + +Each alert can link to a single issue, while each issue can track up to 50 different alerts. This flexibility lets you group related vulnerabilities or track them individually, depending on your team's workflow. + +You can link alerts to issues in any repository where you have access and {% data variables.product.prodname_github_issues %} is enabled, not just the repository where the alert was found. This is useful when you track work in a central repository or use a separate issue tracker for security fixes. + +## Understanding synchronization behavior + +**Alert and issue statuses are not automatically synchronized.** Changes you make to an alert do not update the linked issue, and vice versa. This means: + +* When you fix the vulnerability and the alert automatically closes, the linked issue remains open until you manually close it. +* When you close or reopen an issue, the alert status stays unchanged. +* When you delete an issue, the link is removed from the alert page and alert list, but the alert itself remains open. + +## Best practices for managing linked alerts and issues + +**Track remediation progress clearly.** When you commit a fix, add a comment to the linked issue noting that the code is updated. After the next {% data variables.product.prodname_code_scanning %} run confirms the alert is closed, manually close the issue. + +**Use labels to show status.** Create issue labels like "code-fixed-awaiting-scan" or use project fields to indicate when a vulnerability is fixed but the issue is waiting for final verification and closure. + +**Assign responsibility.** Use issue assignees to make it clear who owns the remediation work, especially when security and development teams need to coordinate. diff --git a/content/code-security/concepts/code-scanning/index.md b/content/code-security/concepts/code-scanning/index.md index 410d8e920f0f..c39b726db0d6 100644 --- a/content/code-security/concepts/code-scanning/index.md +++ b/content/code-security/concepts/code-scanning/index.md @@ -17,6 +17,7 @@ children: - /setup-types - /about-integration-with-code-scanning - /sarif-files + - /code-scanning-alert-tracking-using-issues - /merge-protection - /multi-repository-variant-analysis - /codeql diff --git a/content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/assessing-code-scanning-alerts-for-your-repository.md b/content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/assessing-code-scanning-alerts-for-your-repository.md index a1c56db15d5c..55a83e78c75b 100644 --- a/content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/assessing-code-scanning-alerts-for-your-repository.md +++ b/content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/assessing-code-scanning-alerts-for-your-repository.md @@ -25,7 +25,7 @@ By default, the {% data variables.product.prodname_code_scanning %} alerts page {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} {% data reusables.repositories.sidebar-code-scanning-alerts %} -1. Optionally, use the free text search box or the dropdown menus to filter alerts. For example, you can filter by the tool that was used to identify alerts. +1. Optionally, use the free text search box or the dropdown menus to filter alerts. For example, you can filter by the tool that was used to identify alerts.{% ifversion code-scanning-link-alert-to-issue %} Linked {% data variables.product.prodname_dotcom %} issues appear alongside their corresponding alerts in the list view.{% endif %} ![Screenshot of {% data variables.product.prodname_code_scanning %} alerts page. The search box and filter dropdown menus are outlined in dark orange.](/assets/images/help/repository/filter-code-scanning-alerts.png) diff --git a/content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/index.md b/content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/index.md index 5a57b325471e..d1ff58fb3d12 100644 --- a/content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/index.md +++ b/content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/index.md @@ -12,6 +12,7 @@ redirect_from: children: - assessing-code-scanning-alerts-for-your-repository - triaging-code-scanning-alerts-in-pull-requests + - linking-code-scanning-alerts-to-github-issues - resolving-code-scanning-alerts - enabling-delegated-alert-dismissal-for-code-scanning - disabling-autofix-for-code-scanning diff --git a/content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/linking-code-scanning-alerts-to-github-issues.md b/content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/linking-code-scanning-alerts-to-github-issues.md new file mode 100644 index 000000000000..28727a407124 --- /dev/null +++ b/content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/linking-code-scanning-alerts-to-github-issues.md @@ -0,0 +1,68 @@ +--- +title: Linking code scanning alerts to GitHub issues +shortTitle: Track alerts in issues +intro: Create or connect {% data variables.product.github %} issues to {% data variables.product.prodname_code_scanning %} alerts to track security fixes in your team's workflow. +permissions: People with write access for the repository can link {% data variables.product.prodname_code_scanning %} alerts to issues. +versions: + feature: code-scanning-link-alert-to-issue +contentType: how-tos +category: + - Find and fix code vulnerabilities +--- + +{% data reusables.code-scanning.alert-tracking-with-issues-preview-note %} + +{% data reusables.code-scanning.enterprise-enable-code-scanning %} + +When {% data variables.product.prodname_code_scanning %} identifies a vulnerability, you can link it to a new or existing {% data variables.product.github %} issue. This makes security fixes visible in your planning and project boards alongside your team's regular development work. For more information about how alert tracking works, see [AUTOTITLE](/code-security/concepts/code-scanning/code-scanning-alert-tracking-using-issues). + +## Creating an issue from an alert + +Create a new issue directly from a {% data variables.product.prodname_code_scanning %} alert, pre-populated with vulnerability details. + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-security %} +{% data reusables.repositories.sidebar-code-scanning-alerts %} +{% data reusables.code-scanning.explore-alert %} +1. On the right of the alert page, click **Tracking**. +1. From the dropdown list, select **Create issue**. + * Select the repository to create the issue in. + * If applicable, select the template to use for your new issue. +1. Fill in the issue, providing as much detail as possible. +1. Optionally, assign the issue to a team member, add labels, or add it to a project. +1. Click **Create**. + +The newly created issue automatically links to the alert. View it by clicking the issue icon below the alert name. + +## Linking an alert to an existing issue + +Connect an existing issue to a {% data variables.product.prodname_code_scanning %} alert. + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-security %} +{% data reusables.repositories.sidebar-code-scanning-alerts %} +{% data reusables.code-scanning.explore-alert %} +1. On the right of the alert page, click **Tracking**. +1. From the dropdown list, select **Add existing {% data variables.product.github %} issue**. +1. Search by issue number or title, or select a different repository by clicking the Back icon. +1. Click the issue you want to link. + +You can link to issues in different repositories, as long as you have access and {% data variables.product.prodname_github_issues %} is enabled. + +## Viewing linked issues + +Once you link an issue to an alert, you can view the linked issue in two places: + +* **On the alert detail page**: Click the issue icon below the alert name to navigate to the full issue details. +* **In the list of {% data variables.product.prodname_code_scanning %} alerts**: Linked issues appear alongside their corresponding alerts in the main alerts list view. + +## Changing or unlinking a linked issue + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-security %} +{% data reusables.repositories.sidebar-code-scanning-alerts %} +{% data reusables.code-scanning.explore-alert %} +1. On the right of the alert page, click **Tracking**. +1. Click **Change or remove issue**. + +When you unlink an issue from an alert, the link is removed from the alert page and alert list. The issue itself remains unchanged. diff --git a/content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/resolving-code-scanning-alerts.md b/content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/resolving-code-scanning-alerts.md index e1978895d946..413c98dedb5e 100644 --- a/content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/resolving-code-scanning-alerts.md +++ b/content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/resolving-code-scanning-alerts.md @@ -80,6 +80,8 @@ Within 30 seconds, {% data variables.product.prodname_copilot_short %} will open Anyone with write permission for a repository can fix an alert by committing a correction to the code. If the repository has {% data variables.product.prodname_code_scanning %} scheduled to run on pull requests, it's best to raise a pull request with your correction. This will trigger {% data variables.product.prodname_code_scanning %} analysis of the changes and test that your fix doesn't introduce any new problems. For more information, see [AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/triaging-code-scanning-alerts-in-pull-requests). +{% data reusables.code-scanning.track-alert-in-issue %} + You can use the free text search or the filters to display a subset of alerts and then in turn mark all matching alerts as closed. Alerts may be fixed in one branch but not in another. You can use the "branch" filter, on the summary of alerts, to check whether an alert is fixed in a particular branch. diff --git a/content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/triaging-code-scanning-alerts-in-pull-requests.md b/content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/triaging-code-scanning-alerts-in-pull-requests.md index 06a88413dad9..206fb87db999 100644 --- a/content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/triaging-code-scanning-alerts-in-pull-requests.md +++ b/content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/triaging-code-scanning-alerts-in-pull-requests.md @@ -71,6 +71,8 @@ You can comment on any {% data variables.product.prodname_code_scanning %} alert You can choose to require all conversations in a pull request, including those on {% data variables.product.prodname_code_scanning %} alerts, to be resolved before a pull request can be merged. For more information, see [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#require-conversation-resolution-before-merging). +{% data reusables.code-scanning.track-alert-in-issue %} + ## Fixing an alert on your pull request Anyone with push access to a pull request can fix a {% data variables.product.prodname_code_scanning %} alert that's identified on that pull request. If you commit changes to the pull request this triggers a new run of the pull request checks. If your changes fix the problem, the alert is closed and the annotation removed. diff --git a/content/copilot/how-tos/copilot-cli/set-up-copilot-cli/authenticate-copilot-cli.md b/content/copilot/how-tos/copilot-cli/set-up-copilot-cli/authenticate-copilot-cli.md index f2feaff18465..f75cfaea969b 100644 --- a/content/copilot/how-tos/copilot-cli/set-up-copilot-cli/authenticate-copilot-cli.md +++ b/content/copilot/how-tos/copilot-cli/set-up-copilot-cli/authenticate-copilot-cli.md @@ -20,9 +20,9 @@ Authentication is required for any other {% data variables.copilot.copilot_cli % When authentication is required, {% data variables.copilot.copilot_cli_short %} supports three methods. The method you use depends on whether you are working interactively or in an automated environment. -* **OAuth device flow**: The default and recommended method for interactive use. When you run `/login` in {% data variables.copilot.copilot_cli_short %}, the CLI generates a one-time code and directs you to authenticate in your browser. This is the simplest way to authenticate. -* **Environment variables**: Recommended for CI/CD pipelines, containers, and non-interactive environments. You set a supported token as an environment variable (`COPILOT_GITHUB_TOKEN`, `GH_TOKEN`, or `GITHUB_TOKEN`), and the CLI uses it automatically without prompting. -* **{% data variables.product.prodname_cli %} fallback**: If you have {% data variables.product.prodname_cli %} (`gh`) (note: the `gh` CLI, not `copilot`) installed and authenticated, {% data variables.copilot.copilot_cli_short %} can use its token automatically. This is the lowest priority method and activates only when no other credentials are found. +* **OAuth device flow**: The default and recommended method for interactive use. When you run `/login` in {% data variables.copilot.copilot_cli_short %}, the CLI generates a one-time code and directs you to authenticate in your browser. This is the simplest way to authenticate. See [Authenticating with OAuth](#authenticating-with-oauth). +* **Environment variables**: Recommended for CI/CD pipelines, containers, and non-interactive environments. You set a supported token as an environment variable (`COPILOT_GITHUB_TOKEN`, `GH_TOKEN`, or `GITHUB_TOKEN`), and the CLI uses it automatically without prompting. See [Authenticating with environment variables](#authenticating-with-environment-variables). +* **{% data variables.product.prodname_cli %} fallback**: If you have {% data variables.product.prodname_cli %} (`gh`) (note: the `gh` CLI, not `copilot`) installed and authenticated, {% data variables.copilot.copilot_cli_short %} can use its token automatically. This is the lowest priority method and activates only when no other credentials are found. See [Authenticating with {% data variables.product.prodname_cli %}](#authenticating-with-github-cli). Once authenticated, {% data variables.copilot.copilot_cli_short %} remembers your login and automatically uses the token for all {% data variables.product.prodname_copilot_short %} API requests. You can log in with multiple accounts, and the CLI will remember the last-used account. Token lifetime and expiration depend on how the token was created on your account or organization settings. diff --git a/content/copilot/reference/copilot-cli-reference/cli-command-reference.md b/content/copilot/reference/copilot-cli-reference/cli-command-reference.md index de7fe6931c46..d8c2867605ee 100644 --- a/content/copilot/reference/copilot-cli-reference/cli-command-reference.md +++ b/content/copilot/reference/copilot-cli-reference/cli-command-reference.md @@ -75,49 +75,53 @@ docsTeamMetrics: | Command | Purpose | |-----------------------------------------------------|---------| | `/add-dir PATH` | Add a directory to the allowed list for file access. | -| `/agent` | Browse and select from available agents (if any). | +| `/agent` | Browse and select from available agents (if any). See [AUTOTITLE](/copilot/concepts/agents/copilot-cli/about-custom-agents). | | `/allow-all`, `/yolo` | Enable all permissions (tools, paths, and URLs). | | `/changelog [SUMMARIZE] [VERSION]` | Display the CLI changelog with an optional AI-generated summary. | | `/clear [PROMPT]`, `/new [PROMPT]` | Start a new conversation. | -| `/compact` | Summarize the conversation history to reduce context window usage. | -| `/context` | Show the context window token usage and visualization. | +| `/compact` | Summarize the conversation history to reduce context window usage. See [AUTOTITLE](/copilot/concepts/agents/copilot-cli/context-management#compaction). | +| `/context` | Show the context window token usage and visualization. See [AUTOTITLE](/copilot/concepts/agents/copilot-cli/context-management#checking-your-context-usage). | | `/copy` | Copy the last response to the clipboard. | | `/cwd`, `/cd [PATH]` | Change the working directory or display the current directory. | -| `/delegate [PROMPT]` | Delegate changes to a remote repository with an AI-generated pull request. | +| `/delegate [PROMPT]` | Delegate changes to a remote repository with an AI-generated pull request. See [AUTOTITLE](/copilot/how-tos/copilot-cli/use-copilot-cli-agents/delegate-tasks-to-cca). | | `/diff` | Review the changes made in the current directory. | | `/exit`, `/quit` | Exit the CLI. | | `/experimental [on\|off\|show]` | Toggle, set, or show experimental features. | | `/feedback` | Provide feedback about the CLI. | | `/fleet [PROMPT]` | Enable parallel subagent execution of parts of a task. See [AUTOTITLE](/copilot/concepts/agents/copilot-cli/fleet). | | `/help` | Show the help for interactive commands. | -| `/ide` | Connect to an IDE workspace. | -| `/init` | Initialize {% data variables.product.prodname_copilot_short %} custom instructions and agentic features for this repository. | +| `/ide` | Connect to an IDE workspace. See [AUTOTITLE](/copilot/how-tos/copilot-cli/connecting-vs-code#managing-the-connection-with-the-ide-slash-command). | +| `/init` | Initialize {% data variables.product.prodname_copilot_short %} custom instructions and agentic features for this repository. See [Project initialization for {% data variables.product.prodname_copilot_short %}](#project-initialization-for-copilot). | | `/instructions` | View and toggle custom instruction files. | | `/keep-alive [on\|busy\|NUMBERm\|NUMBERh]` | Prevent the machine from going to sleep: while a CLI session is active, while the agent is busy, or for a defined length of time. | | `/list-dirs` | Display all of the directories for which file access has been allowed. | | `/login` | Log in to {% data variables.product.prodname_copilot_short %}. | | `/logout` | Log out of {% data variables.product.prodname_copilot_short %}. | | `/lsp [show\|test\|reload\|help] [SERVER-NAME]` | Manage the language server configuration. | -| `/mcp [show\|add\|edit\|delete\|disable\|enable\|auth\|reload] [SERVER-NAME]` | Manage the MCP server configuration. | +| `/mcp [show\|add\|edit\|delete\|disable\|enable\|auth\|reload] [SERVER-NAME]` | Manage the MCP server configuration. See [AUTOTITLE](/copilot/how-tos/copilot-cli/customize-copilot/add-mcp-servers#managing-mcp-servers). | | `/model`, `/models [MODEL]` | Select the AI model you want to use. | | `/on-air`, `/streamer-mode` | Toggle streamer mode (hides preview model names). | | `/plan [PROMPT]` | Create an implementation plan before coding. | -| `/plugin [marketplace\|install\|uninstall\|update\|list] [ARGS...]` | Manage plugins and plugin marketplaces. | +| `/plugin [marketplace\|install\|uninstall\|update\|list] [ARGS...]` | Manage plugins and plugin marketplaces. See [AUTOTITLE](/copilot/concepts/agents/copilot-cli/about-cli-plugins). | | `/pr [view\|create\|fix\|auto]` | Operate on pull requests for the current branch. | -| `/remote` | Enable remote access to this session from {% data variables.product.prodname_dotcom_the_website %} and {% data variables.product.prodname_mobile %}. | +| `/remote` | Enable remote access to this session from {% data variables.product.prodname_dotcom_the_website %} and {% data variables.product.prodname_mobile %}. See [AUTOTITLE](/copilot/how-tos/copilot-cli/steer-remotely). | | `/rename [NAME]` | Rename the current session (auto-generates a name if omitted; alias for `/session rename`). | +| `/research TOPIC` | Run a deep research investigation using {% data variables.product.github %} search and web sources. See [AUTOTITLE](/copilot/concepts/agents/copilot-cli/research). | | `/reset-allowed-tools` | Reset the list of allowed tools. | | `/restart` | Restart the CLI, preserving the current session. | | `/resume [SESSION-ID]` | Switch to a different session by choosing from a list (optionally specify a session ID). | -| `/review [PROMPT]` | Run the code review agent to analyze changes. | +| `/review [PROMPT]` | Run the code review agent to analyze changes. See [AUTOTITLE](/copilot/how-tos/copilot-cli/use-copilot-cli-agents/agentic-code-review). | | `/session [checkpoints [n]\|files\|plan\|rename NAME]` | Show session information and a workspace summary. Use the subcommands for details. | | `/share [file\|gist] [session\|research] [PATH]` | Share the session to a Markdown file or {% data variables.product.github %} gist. | -| `/skills [list\|info\|add\|remove\|reload] [ARGS...]` | Manage skills for enhanced capabilities. | +| `/skills [list\|info\|add\|remove\|reload] [ARGS...]` | Manage skills for enhanced capabilities. See [AUTOTITLE](/copilot/how-tos/copilot-cli/customize-copilot/create-skills). | +| `/tasks` | View and manage background tasks (subagents and shell sessions). | | `/terminal-setup` | Configure the terminal for multiline input support (Shift+Enter and Ctrl+Enter). | | `/theme [show\|set\|list] [auto\|THEME-ID]` | View or configure the terminal theme. | -| `/usage` | Display session usage metrics and statistics. | | `/undo`, `/rewind` | Rewind the last turn and revert file changes. | +| `/update` | Update the CLI to the latest version. | +| `/usage` | Display session usage metrics and statistics. | | `/user [show\|list\|switch]` | Manage the current {% data variables.product.github %} user. | +| `/version` | Display version information and check for updates. | For a complete list of available slash commands enter `/help` in the CLI's interactive interface. @@ -129,16 +133,16 @@ For a complete list of available slash commands enter `/help` in the CLI's inter | `--add-dir=PATH` | Add a directory to the allowed list for file access (can be used multiple times). | | `--add-github-mcp-tool=TOOL` | Add a tool to enable for the {% data variables.product.github %} MCP server, instead of the default CLI subset (can be used multiple times). Use `*` for all tools. | | `--add-github-mcp-toolset=TOOLSET` | Add a toolset to enable for the {% data variables.product.github %} MCP server, instead of the default CLI subset (can be used multiple times). Use `all` for all toolsets. | -| `--additional-mcp-config=JSON` | Add an MCP server for this session only. The server configuration can be supplied as a JSON string or a file path (prefix with `@`). Augments the configuration from `~/.copilot/mcp-config.json`. Overrides any installed MCP server configuration with the same name. | -| `--agent=AGENT` | Specify a {% data variables.copilot.copilot_custom_agent_short %} to use. | +| `--additional-mcp-config=JSON` | Add an MCP server for this session only. The server configuration can be supplied as a JSON string or a file path (prefix with `@`). Augments the configuration from `~/.copilot/mcp-config.json`. Overrides any installed MCP server configuration with the same name. See [AUTOTITLE](/copilot/how-tos/copilot-cli/customize-copilot/add-mcp-servers). | +| `--agent=AGENT` | Specify a {% data variables.copilot.copilot_custom_agent_short %} to use. See [AUTOTITLE](/copilot/concepts/agents/copilot-cli/about-custom-agents). | | `--allow-all` | Enable all permissions (equivalent to `--allow-all-tools --allow-all-paths --allow-all-urls`). | | `--allow-all-paths` | Disable file path verification and allow access to any path. | | `--allow-all-tools` | Allow all tools to run automatically without confirmation. Required when using the CLI programmatically (env: `COPILOT_ALLOW_ALL`). | | `--allow-all-urls` | Allow access to all URLs without confirmation. | -| `--allow-tool=TOOL ...` | Tools the CLI has permission to use. Will not prompt for permission. For multiple tools, use a quoted, comma-separated list. | +| `--allow-tool=TOOL ...` | Tools the CLI has permission to use. Will not prompt for permission. For multiple tools, use a quoted, comma-separated list. See [AUTOTITLE](/copilot/how-tos/copilot-cli/allowing-tools#allowing-or-denying-permission-for-specific-tools). | | `--allow-url=URL ...` | Allow access to specific URLs or domains. For multiple URLs, use a quoted, comma-separated list. | | `--autopilot` | Enable autopilot continuation in prompt mode. See [AUTOTITLE](/copilot/concepts/agents/copilot-cli/autopilot). | -| `--available-tools=TOOL ...` | Only these tools will be available to the model. For multiple tools, use a quoted, comma-separated list. | +| `--available-tools=TOOL ...` | Only these tools will be available to the model. For multiple tools, use a quoted, comma-separated list. See [AUTOTITLE](/copilot/how-tos/copilot-cli/allowing-tools). | | `--banner` | Show the startup banner. | | `--bash-env` | Enable `BASH_ENV` support for bash shells. | | `--config-dir=PATH` | Set the configuration directory (default: `~/.copilot`). | @@ -159,6 +163,7 @@ For a complete list of available slash commands enter `/help` in the CLI's inter | `--log-dir=DIRECTORY` | Set the log file directory (default: `~/.copilot/logs/`). | | `--log-level=LEVEL` | Set the log level (choices: `none`, `error`, `warning`, `info`, `debug`, `all`, `default`). | | `--max-autopilot-continues=COUNT` | Maximum number of continuation messages in autopilot mode (default: unlimited). See [AUTOTITLE](/copilot/concepts/agents/copilot-cli/autopilot). | +| `--mode=MODE` | Set the initial agent mode (choices: `interactive`, `plan`, `autopilot`). Cannot be combined with `--autopilot` or `--plan`. | | `--model=MODEL` | Set the AI model you want to use. | | `--mouse[=VALUE]` | Enable mouse support in alt screen mode. VALUE can be `on` (default) or `off`. When enabled, the CLI captures mouse events in alt screen mode—scroll wheel, clicks, etc. When disabled, the terminal's native mouse behavior is preserved. Once set the setting is persisted by being written to your configuration file.| | `--no-ask-user` | Disable the `ask_user` tool (the agent works autonomously without asking questions). | @@ -170,10 +175,11 @@ For a complete list of available slash commands enter `/help` in the CLI's inter | `--no-mouse` | Disable mouse support. | | `--no-remote` | Disable remote access for this session. | | `--output-format=FORMAT` | FORMAT can be `text` (default) or `json` (outputs JSONL: one JSON object per line). | -| `-p PROMPT`, `--prompt=PROMPT` | Execute a prompt programmatically (exits after completion). | +| `-p PROMPT`, `--prompt=PROMPT` | Execute a prompt programmatically (exits after completion). See [AUTOTITLE](/copilot/how-tos/copilot-cli/automate-copilot-cli/run-cli-programmatically). | +| `--plan` | Start in plan mode. Shorthand for `--mode plan`. Cannot be combined with `--mode` or `--autopilot`. | | `--plain-diff` | Disable rich diff rendering (syntax highlighting via the diff tool specified by your git config). | | `--plugin-dir=DIRECTORY` | Load a plugin from a local directory (can be used multiple times). | -| `--remote` | Enable remote access to this session from {% data variables.product.prodname_dotcom_the_website %} and {% data variables.product.prodname_mobile %}. | +| `--remote` | Enable remote access to this session from {% data variables.product.prodname_dotcom_the_website %} and {% data variables.product.prodname_mobile %}. See [AUTOTITLE](/copilot/how-tos/copilot-cli/steer-remotely). | | `--resume=SESSION-ID` | Resume a previous interactive session by choosing from a list (optionally specify a session ID). | | `-s`, `--silent` | Output only the agent response (without usage statistics), useful for scripting with `-p`. | | `--screen-reader` | Enable screen reader optimizations. | @@ -186,6 +192,9 @@ For a complete list of available slash commands enter `/help` in the CLI's inter For a complete list of commands and options, run `copilot help`. +> [!NOTE] +> The `--remote` and `--no-remote` options require the remote sessions feature to be available on your account. + ## Tool availability values The `--available-tools` and `--excluded-tools` options support the following values for specifying tools: diff --git a/content/integrations/how-tos/slack/use-github-in-slack.md b/content/integrations/how-tos/slack/use-github-in-slack.md index 7d1c88c981e9..b7f9e1593dce 100644 --- a/content/integrations/how-tos/slack/use-github-in-slack.md +++ b/content/integrations/how-tos/slack/use-github-in-slack.md @@ -36,7 +36,8 @@ To use a slash command, type `/github` followed by the command you want to execu |`/github close [issue link]`|Closes the specified issue as completed.| |`/github close [issue link] reason:"not planned"`|Closes the specified issue with a reason. Replace `"not planned"` with your reason.| |`/github reopen [issue link]`|Reopens the specified issue.| -|`/github signin`|Restarts the "Connect your GitHub account" workflow.| +|`/github signin`|Restarts the "Connect your {% data variables.product.github %} account" workflow.| +|`/github signout`|Disconnects your {% data variables.product.github %} account from your Slack user.| >[!NOTE] When you subscribe a channel to a repository, the channel will receive notifications for all `open`, `close`, and `reopen` events on pull requests and issues in that repository. The channel will also receive notifications of any `push` events directly to the repository's default branch. diff --git a/content/issues/planning-and-tracking-with-projects/understanding-fields/about-date-fields.md b/content/issues/planning-and-tracking-with-projects/understanding-fields/about-date-fields.md index 6647b4b1ad8b..b445b2ab1c5a 100644 --- a/content/issues/planning-and-tracking-with-projects/understanding-fields/about-date-fields.md +++ b/content/issues/planning-and-tracking-with-projects/understanding-fields/about-date-fields.md @@ -17,6 +17,9 @@ You can filter for date values using the `YYYY-MM-DD` format, for example: `date If your project makes use of date fields, you can use the roadmap layout to view items on a timeline. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/changing-the-layout-of-a-view) and [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-roadmap-layout). +> [!NOTE] +> Date fields do not currently support default values. + ## Adding a date field {% data reusables.projects.new-field %} diff --git a/content/issues/planning-and-tracking-with-projects/understanding-fields/about-single-select-fields.md b/content/issues/planning-and-tracking-with-projects/understanding-fields/about-single-select-fields.md index 88fa53b49421..a536dbf264f8 100644 --- a/content/issues/planning-and-tracking-with-projects/understanding-fields/about-single-select-fields.md +++ b/content/issues/planning-and-tracking-with-projects/understanding-fields/about-single-select-fields.md @@ -25,6 +25,17 @@ Single select fields can contain up to 50 options. * To add additional options, click **Add option**. 1. Click **Save**. +## Setting a default value + +Choose an existing option as the default value for a single select field. New items added to the project are automatically pre-populated with that option. + +1. Access your project's settings. +1. Click the name of the single select field to configure. +1. In the list of options, select the option to use as the default. +1. Click **Save**. + +To remove a default value, deselect the currently selected default option, then click **Save**. Removing a default value does not affect existing items in the project. + ## Editing a single select field You can set descriptions and colors for each of your single select options. diff --git a/content/issues/planning-and-tracking-with-projects/understanding-fields/about-text-and-number-fields.md b/content/issues/planning-and-tracking-with-projects/understanding-fields/about-text-and-number-fields.md index 511f7ad8116b..759e71df17b0 100644 --- a/content/issues/planning-and-tracking-with-projects/understanding-fields/about-text-and-number-fields.md +++ b/content/issues/planning-and-tracking-with-projects/understanding-fields/about-text-and-number-fields.md @@ -30,3 +30,14 @@ Number fields can also be used in filters. You can use `>`, `>=`, `<`, `<=`, and {% data reusables.projects.new-field %} 1. Select **Number**. 1. Click **Save**. + +## Setting a default value + +Set a default value for text or number fields. New items added to the project are automatically pre-populated with that value. + +{% data reusables.projects.project-settings %} +1. Click the name of the text or number field to configure. +1. In the **Default value** field, type the value to use as the default. +1. Click **Save**. + +To remove a default value, clear the **Default value** field, then click **Save**. Removing a default value does not affect existing items in the project. diff --git a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository.md b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository.md index 3d8fce74210f..dc9f947bcb62 100644 --- a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository.md @@ -115,6 +115,29 @@ You can view insights for rulesets to see how rulesets are affecting a repositor {% endif %} +{% ifversion rule-insights-dashboard %} + +### Rule insights dashboard + +> [!NOTE] +> The rule insights dashboard is in {% data variables.release-phases.public_preview %} and subject to change. It is available for {% data variables.product.prodname_team %} and {% data variables.product.prodname_ghe_cloud %} plans. + +The rule insights dashboard gives you a visual, high-level summary of rule evaluation activity for your repository, including: + +- **Successes, failures, and bypasses over time**: A chart showing trends in rule evaluation results, helping you spot spikes in blocked pushes or unusual patterns. +- **Top bypassers**: A list of the most active bypassers for your rulesets. + +Each chart links back to the rule insights page with filters prefilled, so you can quickly drill into specific statuses, bypassers, or time ranges. + +To view the dashboard: + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-settings %} +1. In the left sidebar, under "Code and automation," click **Rules**, then click **Insights**. +1. At the top of the "Rule Insights" page, view the dashboard charts for an overview of rule evaluation activity. + +{% endif %} + {% endif %} {% ifversion push-rule-delegated-bypass %} diff --git a/data/features/code-scanning-link-alert-to-issue.yml b/data/features/code-scanning-link-alert-to-issue.yml new file mode 100644 index 000000000000..c0938f1b2d0f --- /dev/null +++ b/data/features/code-scanning-link-alert-to-issue.yml @@ -0,0 +1,5 @@ +# Reference: #20489 - Code scanning alerts link to GitHub issues to facilitate collaboration and work management +versions: + fpt: '*' + ghec: '*' + ghes: '>3.21' diff --git a/data/features/rule-insights-dashboard.yml b/data/features/rule-insights-dashboard.yml new file mode 100644 index 000000000000..14ba8f5e2d5b --- /dev/null +++ b/data/features/rule-insights-dashboard.yml @@ -0,0 +1,3 @@ +versions: + fpt: '*' + ghec: '*' diff --git a/data/reusables/code-scanning/alert-tracking-with-issues-preview-note.md b/data/reusables/code-scanning/alert-tracking-with-issues-preview-note.md new file mode 100644 index 000000000000..2d4884d097a5 --- /dev/null +++ b/data/reusables/code-scanning/alert-tracking-with-issues-preview-note.md @@ -0,0 +1,2 @@ +> [!NOTE] +> {% data variables.product.prodname_code_scanning_caps %} alert tracking using {% data variables.product.github %} issues is currently in {% data variables.release-phases.public_preview %} and subject to change. diff --git a/data/reusables/code-scanning/track-alert-in-issue.md b/data/reusables/code-scanning/track-alert-in-issue.md new file mode 100644 index 000000000000..15d95017fb23 --- /dev/null +++ b/data/reusables/code-scanning/track-alert-in-issue.md @@ -0,0 +1,5 @@ +{% ifversion code-scanning-link-alert-to-issue %} + +To track remediation work in your team's workflow without leaving {% data variables.product.github %}, you can link alerts to issues. See [AUTOTITLE](/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/linking-code-scanning-alerts-to-github-issues). + +{% endif %} diff --git a/data/reusables/repositories/about-ruleset-insights.md b/data/reusables/repositories/about-ruleset-insights.md index 43e33f0da4e4..958a6afc080e 100644 --- a/data/reusables/repositories/about-ruleset-insights.md +++ b/data/reusables/repositories/about-ruleset-insights.md @@ -6,6 +6,6 @@ On the "Rule Insights" page, you will see a timeline of the following user actio If a ruleset is running in "Evaluate" mode, you can see actions that would have passed or failed if the ruleset had been active. -Additonally these insights are availible via the rule suites [REST API](/rest/repos/rule-suites). +Additionally, these insights are available via the rule suites [REST API](/rest/repos/rule-suites). ![Screenshot of the "Rule Insights" page. Three actions are listed marked: "Pass," "Bypass," and "Fail". The failed action has with an "evaluate" label.](/assets/images/help/repository/rule-insights.png) diff --git a/data/reusables/support/submit-a-ticket.md b/data/reusables/support/submit-a-ticket.md index 19085e9c5853..8619aa2afb0a 100644 --- a/data/reusables/support/submit-a-ticket.md +++ b/data/reusables/support/submit-a-ticket.md @@ -11,6 +11,7 @@ > [!NOTE] > * For {% data variables.product.premium_support_plan %}, {% data variables.product.premium_plus_support_plan %}, or {% data variables.product.microsoft_premium_plus_support_plan %} support, you need to choose an enterprise account with a {% data variables.contact.premium_support %} plan. If you don't see an Enterprises section in the dropdown menu, you're not entitled to open support tickets on behalf of an enterprise account. For more information, see [AUTOTITLE](/support/learning-about-github-support/about-github-support#about-support-entitlement) > * To see a list of your enterprise accounts with a {% data variables.contact.premium_support %} plan, you must be signed into the {% data variables.contact.enterprise_portal %}. For more information, see [AUTOTITLE](/support/contacting-github-support/getting-your-enterprise-started-with-the-github-support-portal). + > * If there is a mismatch between the account you select and the identity or topic you are discussing, {% data variables.contact.github_support %} may instruct or require you to open a new ticket linked to the correct account. {% endif %} 1. Select the **From** dropdown menu and click the email address you'd like {% data variables.contact.github_support %} to contact. diff --git a/src/content-pipelines/state/copilot-cli.sha b/src/content-pipelines/state/copilot-cli.sha index dbf211204f02..578f9054b180 100644 --- a/src/content-pipelines/state/copilot-cli.sha +++ b/src/content-pipelines/state/copilot-cli.sha @@ -1 +1 @@ -36e4da8c7502ef8fc3f3380182cd7ea164365662 +3aa5cd78f969f848b3607863b5f73ba722a3f489 diff --git a/src/secret-scanning/data/pattern-docs/fpt/public-docs.yml b/src/secret-scanning/data/pattern-docs/fpt/public-docs.yml index dea0b0e8dec3..16a917c84ce2 100644 --- a/src/secret-scanning/data/pattern-docs/fpt/public-docs.yml +++ b/src/secret-scanning/data/pattern-docs/fpt/public-docs.yml @@ -1452,6 +1452,36 @@ hasExtendedMetadata: false base64Supported: false isduplicate: false +- provider: Cloudflare + supportedSecret: Cloudflare Account API Token + secretType: cloudflare_account_api_token + isPublic: true + isPrivateWithGhas: true + hasPushProtection: false + hasValidityCheck: false + hasExtendedMetadata: false + base64Supported: false + isduplicate: false +- provider: Cloudflare + supportedSecret: Cloudflare Global User API Key + secretType: cloudflare_global_user_api_key + isPublic: true + isPrivateWithGhas: true + hasPushProtection: false + hasValidityCheck: false + hasExtendedMetadata: false + base64Supported: false + isduplicate: false +- provider: Cloudflare + supportedSecret: Cloudflare User API Token + secretType: cloudflare_user_api_token + isPublic: true + isPrivateWithGhas: true + hasPushProtection: false + hasValidityCheck: false + hasExtendedMetadata: false + base64Supported: false + isduplicate: false - provider: Cockroach Labs supportedSecret: CockroachDB Cloud API Key secretType: ccdb_api_key diff --git a/src/secret-scanning/data/pattern-docs/ghec/public-docs.yml b/src/secret-scanning/data/pattern-docs/ghec/public-docs.yml index dea0b0e8dec3..16a917c84ce2 100644 --- a/src/secret-scanning/data/pattern-docs/ghec/public-docs.yml +++ b/src/secret-scanning/data/pattern-docs/ghec/public-docs.yml @@ -1452,6 +1452,36 @@ hasExtendedMetadata: false base64Supported: false isduplicate: false +- provider: Cloudflare + supportedSecret: Cloudflare Account API Token + secretType: cloudflare_account_api_token + isPublic: true + isPrivateWithGhas: true + hasPushProtection: false + hasValidityCheck: false + hasExtendedMetadata: false + base64Supported: false + isduplicate: false +- provider: Cloudflare + supportedSecret: Cloudflare Global User API Key + secretType: cloudflare_global_user_api_key + isPublic: true + isPrivateWithGhas: true + hasPushProtection: false + hasValidityCheck: false + hasExtendedMetadata: false + base64Supported: false + isduplicate: false +- provider: Cloudflare + supportedSecret: Cloudflare User API Token + secretType: cloudflare_user_api_token + isPublic: true + isPrivateWithGhas: true + hasPushProtection: false + hasValidityCheck: false + hasExtendedMetadata: false + base64Supported: false + isduplicate: false - provider: Cockroach Labs supportedSecret: CockroachDB Cloud API Key secretType: ccdb_api_key