From 072c62999e7756804ef243b02d38a3aff625caab Mon Sep 17 00:00:00 2001 From: hubwriter Date: Mon, 6 Jan 2025 09:28:17 +0000 Subject: [PATCH 01/17] Copilot: fix bad link and typo (#53755) --- .../managing-copilot-policies-as-an-individual-subscriber.md | 2 +- .../github-terms-for-additional-products-and-features.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-copilot-policies-as-an-individual-subscriber.md b/content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-copilot-policies-as-an-individual-subscriber.md index 9c58b66d4e27..e4cbcdeefbcc 100644 --- a/content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-copilot-policies-as-an-individual-subscriber.md +++ b/content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-copilot-policies-as-an-individual-subscriber.md @@ -33,7 +33,7 @@ If you choose to allow suggestions matching public code, when {% data variables. ## Enabling or disabling prompt and suggestion collection -You can choose whether your prompts and {% data variables.product.prodname_copilot_short %}'s suggestions are collected and retained by {% data variables.product.prodname_dotcom %}, and further processed and shared with Microsoft. For more information about data that {% data variables.product.prodname_copilot %} may collect depending on your settings, see [AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-terms-for-additional-products-and-features#github-copilot) and the [{% data variables.product.prodname_copilot %} privacy FAQ](https://github.com/features/copilot/#faq-privacy-copilot-for-business). +You can choose whether your prompts and {% data variables.product.prodname_copilot_short %}'s suggestions are collected and retained by {% data variables.product.prodname_dotcom %}, and further processed and shared with Microsoft. For more information about data that {% data variables.product.prodname_copilot %} may collect depending on your settings, see [AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-terms-for-additional-products-and-features#github-copilot) and the [{% data variables.product.prodname_copilot %} privacy FAQ](https://github.com/features/copilot/#faq). {% data reusables.user-settings.copilot-settings %} 1. To allow or prevent {% data variables.product.prodname_dotcom %} using your data, select or deselect **Allow {% data variables.product.prodname_dotcom %} to use my code snippets from the code editor for product improvements**. diff --git a/content/site-policy/github-terms/github-terms-for-additional-products-and-features.md b/content/site-policy/github-terms/github-terms-for-additional-products-and-features.md index 633d5f78939b..6ad07a563607 100644 --- a/content/site-policy/github-terms/github-terms-for-additional-products-and-features.md +++ b/content/site-policy/github-terms/github-terms-for-additional-products-and-features.md @@ -116,7 +116,7 @@ Your use of GitHub Copilot is subject to the GitHub [Acceptable Use Policies](/s _Data_ -GitHub Copilot (i) may collect and process data based on your settings and the sepcific GitHub Copilot Service you use - this may include Prompts, Suggestions, and code snippets, and (ii) will collect additional usage information through the GitHub Copilot Service you use tied to your Account - this may include Service Usage Information, Website Usage Data, and Feedback Data. Upon your instructions, we may share this data with third-party applications such as those on the [GitHub Marketplace](https://github.com/marketplace) or third-party AI models of your choosing. This may include personal data, as referenced in the [GitHub Privacy Statement](/site-policy/privacy-policies/github-privacy-statement). You can learn more about the collection and use of GitHub Copilot data in the [GitHub Copilot Trust Center](https://resources.github.com/copilot-trust-center/). +GitHub Copilot (i) may collect and process data based on your settings and the specific GitHub Copilot Service you use - this may include Prompts, Suggestions, and code snippets, and (ii) will collect additional usage information through the GitHub Copilot Service you use tied to your Account - this may include Service Usage Information, Website Usage Data, and Feedback Data. Upon your instructions, we may share this data with third-party applications such as those on the [GitHub Marketplace](https://github.com/marketplace) or third-party AI models of your choosing. This may include personal data, as referenced in the [GitHub Privacy Statement](/site-policy/privacy-policies/github-privacy-statement). You can learn more about the collection and use of GitHub Copilot data in the [GitHub Copilot Trust Center](https://resources.github.com/copilot-trust-center/). For GitHub Copilot Free users, the data collected by GitHub Copilot may be used for AI Model training where permitted and if you allow in your settings. From f83df362ad4e2ae8ccac5cccdd6b4f75c1e0dc7a Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Mon, 6 Jan 2025 01:34:42 -0800 Subject: [PATCH 02/17] Update audit log event data (#53752) Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> --- src/audit-logs/lib/config.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/audit-logs/lib/config.json b/src/audit-logs/lib/config.json index 42c52e76fcbd..dbe913ddaefe 100644 --- a/src/audit-logs/lib/config.json +++ b/src/audit-logs/lib/config.json @@ -3,5 +3,5 @@ "apiOnlyEvents": "This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.", "apiRequestEvent": "This event is only available via audit log streaming." }, - "sha": "5a0cf4257c3fb76abb87498a8eceeab4a78c710a" + "sha": "1cc65784575c62d12e1571bedef9126c2b7d2f15" } \ No newline at end of file From e3ac5872b20c40927bff6314f12fb5f891227c5d Mon Sep 17 00:00:00 2001 From: hubwriter Date: Mon, 6 Jan 2025 09:48:28 +0000 Subject: [PATCH 03/17] Reword text about the Bing skill teaching Copilot (#53698) --- .../asking-github-copilot-questions-in-github.md | 2 +- .../asking-github-copilot-questions-in-your-ide.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/content/copilot/using-github-copilot/asking-github-copilot-questions-in-github.md b/content/copilot/using-github-copilot/asking-github-copilot-questions-in-github.md index 40d62c2da744..43a50c201be0 100644 --- a/content/copilot/using-github-copilot/asking-github-copilot-questions-in-github.md +++ b/content/copilot/using-github-copilot/asking-github-copilot-questions-in-github.md @@ -61,7 +61,7 @@ The skills you can use in {% data variables.product.prodname_copilot_chat_dotcom | **Repository details** | Retrieves a specific {% data variables.product.prodname_dotcom %} repository. This is useful for finding out details such as the repository owner and the main language used. | Yes | `Tell me about this repo` | | **Semantic code search** | Natural language semantic code search in the default branch of the Git repository. This skill is useful when you want to know where or how certain functionality has been implemented in the code. | Yes

Available for all repositories with a {% data variables.product.prodname_copilot_enterprise_short %} subscription, and for public repositories with a {% data variables.product.prodname_copilot_individuals_short %} or {% data variables.product.prodname_copilot_business_short %} subscription. | `How does this repo manage HTTP requests and responses?`| | **Support search** | Retrieves information from the {% data variables.contact.contact_support_portal %}. This skill is useful for asking {% data variables.product.prodname_copilot_chat_short %} about {% data variables.product.prodname_dotcom %} products and support related questions. | Yes | `Can I use {% data variables.product.prodname_copilot_short %} knowledge bases with {% data variables.product.prodname_copilot_individuals_short %}?` | -| **Web search** | Searches the web using the Bing search engine. This skill is useful for teaching {% data variables.product.prodname_copilot_short %} about recent events, new developments, trends, technologies, or extremely specific, detailed, or niche subjects. | No

{% ifversion fpt %}_For {% data variables.product.prodname_copilot_individuals_short %}:_
Enable in your user settings.

_For {% data variables.product.prodname_copilot_business_short %}:_
Enable in organization settings.{% else %}Enable in enterprise or organization settings.{% endif %} | `What are some recent articles about SAT tokens securing against vulnerabilities in Node?` | +| **Web search** | Searches the web using the Bing search engine. This skill allows {% data variables.product.prodname_copilot_short %} to access information about recent events, new developments, trends, technologies, or extremely specific, detailed, or niche subjects. | No

{% ifversion fpt %}_For {% data variables.product.prodname_copilot_individuals_short %}:_
Enable in your user settings.

_For {% data variables.product.prodname_copilot_business_short %}:_
Enable in organization settings.{% else %}Enable in enterprise or organization settings.{% endif %} | `What are some recent articles about SAT tokens securing against vulnerabilities in Node?` | ## AI models for {% data variables.product.prodname_copilot_chat_short %} diff --git a/content/copilot/using-github-copilot/asking-github-copilot-questions-in-your-ide.md b/content/copilot/using-github-copilot/asking-github-copilot-questions-in-your-ide.md index d74b61f71b67..ee16f17bdafd 100644 --- a/content/copilot/using-github-copilot/asking-github-copilot-questions-in-your-ide.md +++ b/content/copilot/using-github-copilot/asking-github-copilot-questions-in-your-ide.md @@ -130,7 +130,7 @@ The skills you can use in {% data variables.product.prodname_copilot_chat_short | **Repository details** | Retrieves a specific {% data variables.product.prodname_dotcom %} repository. This is useful for finding out details such as the repository owner and the main language used. | Yes | `@github Tell me about PATH-TO-REPOSITORY` | | **Semantic code search** | Natural language semantic code search in the default branch of the Git repository. This skill is useful when you want to know where or how certain functionality has been implemented in the code. For more information, see [AUTOTITLE](/copilot/using-github-copilot/indexing-repositories-for-copilot-chat). | Yes

Available for all repositories with a {% data variables.product.prodname_copilot_enterprise_short %} subscription, and for public repositories with a {% data variables.product.prodname_copilot_individuals_short %} or {% data variables.product.prodname_copilot_business_short %} subscription. | `How does this repo manage HTTP requests and responses?`| | **Support search** | Retrieves information from the {% data variables.contact.contact_support_portal %}. This skill is useful for asking {% data variables.product.prodname_copilot_chat_short %} about {% data variables.product.prodname_dotcom %} products and support related questions. | Yes | `@github Can I use {% data variables.product.prodname_copilot_short %} knowledge bases with {% data variables.product.prodname_copilot_individuals_short %}?` | -| **Web search** | Searches the web using the Bing search engine. This skill is useful for teaching {% data variables.product.prodname_copilot_short %} about recent events, new developments, trends, technologies, or extremely specific, detailed, or niche subjects. | No

{% ifversion fpt %}_For {% data variables.product.prodname_copilot_individuals_short %}:_
Enable in your user settings.

_For {% data variables.product.prodname_copilot_business_short %}:_
Enable in organization settings.{% else %}Enable in enterprise or organization settings.{% endif %} | `@github #web What are some recent articles about SAT tokens securing against vulnerabilities in Node?` | +| **Web search** | Searches the web using the Bing search engine. This skill allows {% data variables.product.prodname_copilot_short %} to access information about recent events, new developments, trends, technologies, or extremely specific, detailed, or niche subjects. | No

{% ifversion fpt %}_For {% data variables.product.prodname_copilot_individuals_short %}:_
Enable in your user settings.

_For {% data variables.product.prodname_copilot_business_short %}:_
Enable in organization settings.{% else %}Enable in enterprise or organization settings.{% endif %} | `@github #web What are some recent articles about SAT tokens securing against vulnerabilities in Node?` | {% ifversion ghec %} @@ -284,7 +284,7 @@ The skills you can use in {% data variables.product.prodname_copilot_chat_short | **Lexical code search** | Keyword code search in the default branch of the Git repository. This skill is useful when you want to know about specific functions, methods or keywords that exist in the code. This skill leverages most of the functionality available to [{% data variables.product.prodname_dotcom %} Search](/search-github/github-code-search/understanding-github-code-search-syntax#using-qualifiers) like `symbol` and `path`. | Yes | `Find me the tests for the GitService class` | | **Path search** | Retrieves a specific file in the default branch of the Git repository. This skill is useful when you provide the exact path of a file in the repository. | Yes | `@github What logic does user_auth.js encapsulate?` | | **Semantic code search** | Natural language semantic code search in the default branch of the Git repository. This skill is useful when you want to know where or how certain functionality has been implemented in the code. For more information, see [AUTOTITLE](/copilot/using-github-copilot/indexing-repositories-for-copilot-chat). | Yes

Available for all repositories with a {% data variables.product.prodname_copilot_enterprise_short %} subscription, and for public repositories with a {% data variables.product.prodname_copilot_individuals_short %} or {% data variables.product.prodname_copilot_business_short %} subscription. | `How does this repo manage HTTP requests and responses?`| -| **Web search** | Searches the web using the Bing search engine. This skill is useful for teaching Copilot about recent events, new developments, trends, technologies, or extremely specific, detailed, or niche subjects. | No

{% ifversion fpt %}_For {% data variables.product.prodname_copilot_individuals_short %}:_
Enable in your user settings.

_For {% data variables.product.prodname_copilot_business_short %}:_
Enable in organization settings.{% else %}Enable in enterprise or organization settings.{% endif %} | `@github What are some recent articles about SAT tokens securing against vulnerabilities in Node?` | +| **Web search** | Searches the web using the Bing search engine. This skill allows {% data variables.product.prodname_copilot_short %} to access information about recent events, new developments, trends, technologies, or extremely specific, detailed, or niche subjects. | No

{% ifversion fpt %}_For {% data variables.product.prodname_copilot_individuals_short %}:_
Enable in your user settings.

_For {% data variables.product.prodname_copilot_business_short %}:_
Enable in organization settings.{% else %}Enable in enterprise or organization settings.{% endif %} | `@github What are some recent articles about SAT tokens securing against vulnerabilities in Node?` | {% ifversion ghec %} From 7fd4f5ae196d4ec066aa9fe7c0715c69db55f810 Mon Sep 17 00:00:00 2001 From: hubwriter Date: Mon, 6 Jan 2025 09:47:50 +0000 Subject: [PATCH 04/17] Copilot content exclusion: update table for dotcom/mobile support (#53663) --- .../excluding-content-from-github-copilot.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/content/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot.md b/content/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot.md index fb15356e9168..c550c02d9d8b 100644 --- a/content/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot.md +++ b/content/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot.md @@ -46,8 +46,11 @@ Repository administrators{% ifversion ghec %}, organization owners, and enterpri | Vim/Neovim | {% octicon "check" aria-label="Supported" %} | Not applicable | | Xcode | {% octicon "check" aria-label="Supported" %} | Not applicable | | Azure Data Studio | {% octicon "x" aria-label="Not supported" %} | Not applicable | -| The {% data variables.product.github %} website | Not applicable | {% octicon "x" aria-label="Not supported" %} | -| {% data variables.product.prodname_mobile %} | Not applicable | {% octicon "x" aria-label="Not supported" %} | +| The {% data variables.product.github %} website | Not applicable | {% octicon "check" aria-label="Supported" %} | +| {% data variables.product.prodname_mobile %} | Not applicable | {% octicon "check" aria-label="Supported" %} | + +> [!NOTE] +> Content exclusion is in {% data variables.release-phases.public_preview %} on the {% data variables.product.github %} website and in {% data variables.product.prodname_mobile %} and is subject to change. ### Limitations of content exclusions From 9d1c973d9830926e95a7268a820c4c96f79da73e Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Mon, 6 Jan 2025 01:47:52 -0800 Subject: [PATCH 05/17] Update audit log event data (#53735) Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> --- src/audit-logs/lib/config.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/audit-logs/lib/config.json b/src/audit-logs/lib/config.json index dbe913ddaefe..290606d8031f 100644 --- a/src/audit-logs/lib/config.json +++ b/src/audit-logs/lib/config.json @@ -3,5 +3,5 @@ "apiOnlyEvents": "This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.", "apiRequestEvent": "This event is only available via audit log streaming." }, - "sha": "1cc65784575c62d12e1571bedef9126c2b7d2f15" + "sha": "aed021929f55efd8e1f773834dff3f02e75d1eba" } \ No newline at end of file From 86b5d312a4cbe700676e0e8406e46a748e0298bd Mon Sep 17 00:00:00 2001 From: Lili <92824518+queenofcorgis@users.noreply.github.com> Date: Mon, 6 Jan 2025 05:06:01 -0500 Subject: [PATCH 06/17] Update managing-environments-for-deployment.md (#53757) Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> --- .../managing-environments-for-deployment.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/actions/managing-workflow-runs-and-deployments/managing-deployments/managing-environments-for-deployment.md b/content/actions/managing-workflow-runs-and-deployments/managing-deployments/managing-environments-for-deployment.md index 9f9dddceaef9..ff1b2db5ede4 100644 --- a/content/actions/managing-workflow-runs-and-deployments/managing-deployments/managing-environments-for-deployment.md +++ b/content/actions/managing-workflow-runs-and-deployments/managing-deployments/managing-environments-for-deployment.md @@ -66,7 +66,7 @@ For more information on reviewing jobs that reference an environment with requir ### Wait timer -Use a wait timer to delay a job for a specific amount of time after the job is initially triggered. The time (in minutes) must be an integer between 1 and 43,200 (30 days). +Use a wait timer to delay a job for a specific amount of time after the job is initially triggered. The time (in minutes) must be an integer between 1 and 43,200 (30 days). Wait time will not count towards your billable time. {% ifversion fpt %} From d6723b058079f8dcdc5480ee276d07ce57b3b4d8 Mon Sep 17 00:00:00 2001 From: Felix Guntrip Date: Mon, 6 Jan 2025 10:17:54 +0000 Subject: [PATCH 07/17] Update broken link to "check-snmp" man page (#53749) Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> --- .../monitoring-your-instance/monitoring-using-snmp.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/admin/monitoring-and-managing-your-instance/monitoring-your-instance/monitoring-using-snmp.md b/content/admin/monitoring-and-managing-your-instance/monitoring-your-instance/monitoring-using-snmp.md index 08ddcae531a4..91284d8316e9 100644 --- a/content/admin/monitoring-and-managing-your-instance/monitoring-your-instance/monitoring-using-snmp.md +++ b/content/admin/monitoring-and-managing-your-instance/monitoring-your-instance/monitoring-using-snmp.md @@ -20,7 +20,7 @@ topics: --- SNMP is a common standard for monitoring devices over a network. We strongly recommend enabling SNMP so you can monitor the health of {% data variables.location.product_location %} and know when to add more memory, storage, or processor power to the host machine. -{% data variables.product.prodname_enterprise %} has a standard SNMP installation, so you can take advantage of the [many plugins](https://www.monitoring-plugins.org/doc/man/check_snmp.html) available for Nagios or for any other monitoring system. +{% data variables.product.prodname_enterprise %} has a standard SNMP installation, so you can take advantage of the [many plugins](https://nagios-plugins.org/doc/man/check_snmp.html) available for Nagios or for any other monitoring system. ## Configuring SNMP v2c From e93f56bac2e11c87e3fea8999831ab02dbc0f976 Mon Sep 17 00:00:00 2001 From: Tomoko Tanaka <28242405+tallzeebaa@users.noreply.github.com> Date: Mon, 6 Jan 2025 19:29:35 +0900 Subject: [PATCH 08/17] Add note for the setup-LANGUAGE limitation (#53748) Co-authored-by: Felix Guntrip Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> --- .../about-self-hosted-runners.md | 1 + .../about-using-actions-in-your-enterprise.md | 6 ++---- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/content/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners.md b/content/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners.md index c6b063300ea7..2a1ddb51f9cb 100644 --- a/content/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners.md +++ b/content/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners.md @@ -124,6 +124,7 @@ The following processor architectures are supported for the self-hosted runner a ## Supported actions on self-hosted runners +All `actions/setup-LANGUAGE` action repositories currently support three platforms: macOS, Windows, and Ubuntu. Some extra configuration might be required to use actions from {% data variables.product.github %} with {% data variables.product.prodname_ghe_server %}, or to use the `actions/setup-LANGUAGE` actions with self-hosted runners that do not have internet access. For more information, see [AUTOTITLE](/admin/github-actions/managing-access-to-actions-from-githubcom) and contact your {% data variables.product.prodname_enterprise %} site administrator. {% endif %} diff --git a/content/admin/managing-github-actions-for-your-enterprise/managing-access-to-actions-from-githubcom/about-using-actions-in-your-enterprise.md b/content/admin/managing-github-actions-for-your-enterprise/managing-access-to-actions-from-githubcom/about-using-actions-in-your-enterprise.md index 2a57a1614116..06084b3be460 100644 --- a/content/admin/managing-github-actions-for-your-enterprise/managing-access-to-actions-from-githubcom/about-using-actions-in-your-enterprise.md +++ b/content/admin/managing-github-actions-for-your-enterprise/managing-access-to-actions-from-githubcom/about-using-actions-in-your-enterprise.md @@ -45,7 +45,9 @@ Each action is a repository in the `actions` organization, and each action repos > [!NOTE] > * When using setup actions (such as `actions/setup-LANGUAGE`) on {% data variables.product.product_name %} with self-hosted runners, you might need to set up the tools cache on runners that do not have internet access. For more information, see [AUTOTITLE](/admin/github-actions/managing-access-to-actions-from-githubcom/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access). +> * All `actions/setup-LANGUAGE` action repositories currently support three platforms: macOS, Windows, and Ubuntu. > * When {% data variables.product.product_name %} is updated, bundled actions are automatically replaced with default versions in the upgrade package. +> * Being bundled with {% data variables.product.prodname_ghe_server %} means the action is available within that environment, but it doesn’t automatically guarantee compatibility with all platforms or self-hosted runners. ## Configuring access to actions on {% data variables.product.prodname_dotcom_the_website %} @@ -53,13 +55,9 @@ Each action is a repository in the `actions` organization, and each action repos The recommended approach is to enable automatic access to all actions from {% data variables.product.prodname_dotcom_the_website %}. You can do this by using {% data variables.product.prodname_github_connect %} to integrate {% data variables.product.product_name %} with {% data variables.product.prodname_ghe_cloud %}. For more information, see [AUTOTITLE](/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect). -{% ifversion ghes %} - > [!NOTE] > Before you can configure access to actions on {% data variables.product.prodname_dotcom_the_website %}, you must configure {% data variables.location.product_location %} to use {% data variables.product.prodname_actions %}. For more information, see [AUTOTITLE](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server). -{% endif %} - {% data reusables.actions.self-hosted-runner-networking-to-dotcom %} {% data reusables.actions.enterprise-limit-actions-use %} From 406f75cd95a4d5bd8ef28bf345f7fddeccf25773 Mon Sep 17 00:00:00 2001 From: Ryan Trauntvein Date: Mon, 6 Jan 2025 02:41:08 -0800 Subject: [PATCH 09/17] Add note about using Alt+F2 to access emergency admin console on GHES (#53743) Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> --- .../accessing-the-administrative-shell-ssh.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh.md b/content/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh.md index 79413075d81b..59efbdced6a7 100644 --- a/content/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh.md +++ b/content/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh.md @@ -66,7 +66,7 @@ Host HOSTNAME ## Accessing the administrative shell using the local console -In an emergency situation, for example if SSH is unavailable, you can access the administrative shell locally. Sign in as the `admin` user and use the password established during initial setup of {% data variables.product.prodname_ghe_server %}. +In an emergency situation, for example if SSH is unavailable, you can access the administrative shell locally if your hypervisor provides console access. Press `Alt` + `F2` to switch to an interactive prompt, then sign in as the `admin` user and use the password established during initial setup of {% data variables.product.prodname_ghe_server %}. ## Access limitations for the administrative shell From 777180ad422e21a44bda601905b836aa109a9dc6 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Mon, 6 Jan 2025 02:43:24 -0800 Subject: [PATCH 10/17] Content strategy bug fix Dec. '24 (#53728) Co-authored-by: Felicity Chapman Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> --- .../contents-of-a-github-docs-article.md | 11 +++++------ .../annotating-code-examples.md | 5 +++-- .../writing-for-github-docs/creating-screenshots.md | 2 ++ 3 files changed, 10 insertions(+), 8 deletions(-) diff --git a/content/contributing/style-guide-and-content-model/contents-of-a-github-docs-article.md b/content/contributing/style-guide-and-content-model/contents-of-a-github-docs-article.md index fea67f234b95..2bd87f5422d6 100644 --- a/content/contributing/style-guide-and-content-model/contents-of-a-github-docs-article.md +++ b/content/contributing/style-guide-and-content-model/contents-of-a-github-docs-article.md @@ -77,13 +77,12 @@ Occasionally, it's relevant to mention required permissions in conceptual conten * Don't include permissions in an article’s intro. * Roles exist at different levels. Refer only to the role at the same level as the action. For example, you need admin access to a repository (repository-level role) to configure protected branches. You can get admin access to a repository by being an organization owner (organization-level role), but the repository-level role is what actually governs your ability to take the action, so that is the only role that should be mentioned in the permissions statement. * Language to use in a permissions statement: + * People with [ACCOUNT ROLE]. * [ACCOUNT ROLE] can [ACTION]. * People with [FEATURE ROLE] access for a [FEATURE] can [ACTION]. * AVOID: [ACCOUNT ROLE] and people with [FEATURE ROLE] access for a [FEATURE] can [ACTION]. -### Examples of permissions statements - -* Article with single permissions statement for multiple procedures: [AUTOTITLE](/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise) +See the [AUTOTITLE](/contributing/style-guide-and-content-model/style-guide#permission-statements-and-product-callouts) for more information on formatting permission statements. ## Product callout @@ -94,10 +93,10 @@ All product callouts are stored as reusables in [`gated-features`](https://githu ### How to write a product callout * Product callouts follow a strict format, clearly identifying the feature and which products it’s available in. -* Product callouts also include a link to "GitHub’s products” and occasionally to another relevant article. +* Product callouts may include links to articles that directly help users understand who can use the feature. These links can be inline links to the specific products or GitHub plans that are required. * Examples: - * [Feature name] is available in [product(s)]. For more information, see "GitHub’s products.” - * [Feature name] is available in public repositories with [free product(s)], and in public and private repositories with [paid products]. For more information, see "GitHub’s products.” + * [Feature name] is available in [product(s)]. + * [Feature name] is available in public repositories with [free product(s)], and in public and private repositories with [paid products]. ### Examples of articles with product callouts diff --git a/content/contributing/writing-for-github-docs/annotating-code-examples.md b/content/contributing/writing-for-github-docs/annotating-code-examples.md index 6dc17e35d85c..d6d4e2e0c2ec 100644 --- a/content/contributing/writing-for-github-docs/annotating-code-examples.md +++ b/content/contributing/writing-for-github-docs/annotating-code-examples.md @@ -35,8 +35,9 @@ You can annotate multiple code examples in a single article, but keep in mind th The following rules apply to all code annotations. * Multiline-style comments, such as `/*` are not supported. -* You can include any number of spaces before the comment tag starts. -* You can include any number of spaces after the comment tag ends. +* There must be a space between the symbol that starts a code annotation and the comment. + * **Use:** `# comment` + * **Avoid:** `#comment` * To create a blank annotation, insert a comment tag with no text after it. Blank annotations are useful if some lines of a sample don't require an annotation. * Strings that begin with `#!` will render in the code block and are not treated as comments. * Anything after the comment tag will be parsed with Markdown. Links, versioning, and other styling will render as if they were written in Markdown. diff --git a/content/contributing/writing-for-github-docs/creating-screenshots.md b/content/contributing/writing-for-github-docs/creating-screenshots.md index 771f743084f3..436b44325c23 100644 --- a/content/contributing/writing-for-github-docs/creating-screenshots.md +++ b/content/contributing/writing-for-github-docs/creating-screenshots.md @@ -93,6 +93,8 @@ In addition to the criteria for inclusion, screenshots must meet the following r * 750–1000 pixels wide for full-column images * File size of 250 KB or less * Descriptive file names, such as `gist-embed-link.png` instead of `right_side_page_03.png` +* Images captured on macOS must be retina images + * In Snagit, select **Snagit** > **Preferences** > **Advanced** and deselect "Scale down retina images when sharing" ### Accessibility From 589acad8fc7ac9e98d16ce5285f8ba7e181c45a8 Mon Sep 17 00:00:00 2001 From: Cody Soyland Date: Mon, 6 Jan 2025 04:57:16 -0600 Subject: [PATCH 11/17] Document image verification in artifact attestations K8s guide (#53703) Signed-off-by: Cody Soyland Co-authored-by: Joe Clark <31087804+jc-clark@users.noreply.github.com> Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> --- ...attestations-with-a-kubernetes-admission-controller.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/content/actions/security-for-github-actions/using-artifact-attestations/enforcing-artifact-attestations-with-a-kubernetes-admission-controller.md b/content/actions/security-for-github-actions/using-artifact-attestations/enforcing-artifact-attestations-with-a-kubernetes-admission-controller.md index b34148e5cb28..27ed0f68b719 100644 --- a/content/actions/security-for-github-actions/using-artifact-attestations/enforcing-artifact-attestations-with-a-kubernetes-admission-controller.md +++ b/content/actions/security-for-github-actions/using-artifact-attestations/enforcing-artifact-attestations-with-a-kubernetes-admission-controller.md @@ -9,6 +9,8 @@ redirect_from: - /actions/security-guides/enforcing-artifact-attestations-with-a-kubernetes-admission-controller --- +>[!NOTE] Before proceeding, ensure you have enabled build provenance for container images, including setting the `push-to-registry` attribute in the [`attest-build-provenance` action](https://github.com/actions/attest-build-provenance) as documented in [Generating build provenance for container images](/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds#generating-build-provenance-for-container-images). This is required for the Policy Controller to verify the attestation. + ## About Kubernetes admission controller [Artifact attestations](/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds) enable you to create unfalsifiable provenance and integrity guarantees for the software you build. In turn, people who consume your software can verify where and how your software was built. @@ -19,6 +21,12 @@ Using the open source [Sigstore Policy Controller](https://docs.sigstore.dev/pol To [install the controller](#getting-started-with-kubernetes-admission-controller), we offer [two Helm charts](https://github.com/github/artifact-attestations-helm-charts): one for deploying the Sigstore Policy Controller, and another for loading the GitHub trust root and a default policy. +### About image verification + +When the Policy Controller is installed, it will intercept all image pull requests and verify the attestation for the image. The attestation must be stored in the image registry as an [OCI attached artifact](https://oras.land/docs/concepts/reftypes/) containing a [Sigstore Bundle](https://docs.sigstore.dev/about/bundle/) which contains the attestation and cryptographic material (e.g. certificates and signatures) used to verify the attestation. A verification process is then performed that ensures the image was built with the specified build provenance and matches any policies enabled by the cluster administrator. + +In order for an image to be verifiable, it must have a valid provenance attestation in the registry, which can be done by enabling the `push-to-registry: true` attribute in the `actions/attest-build-provenance` action. See [Generating build provenance for container images](/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds#generating-build-provenance-for-container-images) for more details on how to generate attestations for container images. + ### About trust roots and policies The Sigstore Policy Controller is primarily configured with trust roots and policies, represented by the Custom Resources `TrustRoot` and `ClusterImagePolicy`. A `TrustRoot` represents a trusted distribution channel for the public key material used to verify attestations. A `ClusterImagePolicy` represents a policy for enforcing attestations on images. From 6fb7f4930db51bb11681e254e85c72c51e3abc9a Mon Sep 17 00:00:00 2001 From: Felix Guntrip Date: Mon, 6 Jan 2025 10:57:42 +0000 Subject: [PATCH 12/17] Update guidance on issue templates in .github repositories (#53723) Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> --- .../creating-a-default-community-health-file.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md b/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md index a4af5f6e7e2d..d62aed29cdbc 100644 --- a/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md +++ b/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md @@ -53,7 +53,7 @@ You can create defaults in your organization or personal account for the followi | _FUNDING.yml_ | A FUNDING file displays a sponsor button in your repository to increase the visibility of funding options for your open source project. For more information, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository). | | {% endif %} | | _GOVERNANCE.md_ | A GOVERNANCE file lets people know about how your project is governed. For example, it might discuss project roles and how decisions are made. | -| Issue and pull request templates and _config.yml_ | Issue and pull request templates customize and standardize the information you'd like contributors to include when they open issues and pull requests in your repository. For more information, see [AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates). | +| Issue and pull request templates and _config.yml_ | Issue and pull request templates customize and standardize the information you'd like contributors to include when they open issues and pull requests in your repository. For more information, see [AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates).

If an issue template sets a label, that label must be created in your `.github` repository and any repositories where the template will be used. | | _SECURITY.md_ | A SECURITY file gives instructions on how to report a security vulnerability in your project and description that hyperlinks the file. For more information, see [AUTOTITLE](/code-security/getting-started/adding-a-security-policy-to-your-repository). | | _SUPPORT.md_ | A SUPPORT file lets people know about ways to get help with your project. For more information, see [AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions/adding-support-resources-to-your-project). | From 8ba01772352b2d951d2602855f5bdbd2ddeb116d Mon Sep 17 00:00:00 2001 From: Junko Suzuki Date: Mon, 6 Jan 2025 20:15:03 +0900 Subject: [PATCH 13/17] Add the operations for reclaiming mannequin for bbs2gh migration (#53571) Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> --- ...nnequins-for-github-enterprise-importer.md | 35 +++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/content/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/reclaiming-mannequins-for-github-enterprise-importer.md b/content/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/reclaiming-mannequins-for-github-enterprise-importer.md index cf032836b927..be68fec8bf6f 100644 --- a/content/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/reclaiming-mannequins-for-github-enterprise-importer.md +++ b/content/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/reclaiming-mannequins-for-github-enterprise-importer.md @@ -53,6 +53,7 @@ The exact command you need to use depends on which extension of the {% data vari * [Reclaiming mannequins with the {% data variables.product.prodname_gei_cli_short %}](#reclaiming-mannequins-with-the-gei-extension) * [Reclaiming mannequins with the {% data variables.product.prodname_ado2gh_cli_short %}](#reclaiming-mannequins-with-the-ado2gh-extension) +* [Reclaiming mannequins with the {% data variables.product.prodname_bbs2gh_cli_short %}](#reclaiming-mannequins-with-the-bbs2gh-extension) #### Reclaiming mannequins with the {% data variables.product.prodname_gei_cli_short %} @@ -122,6 +123,40 @@ If your migration source is Azure DevOps, you can reclaim mannequins with the {% {% data reusables.enterprise-migration-tool.mannequin-reclaim-must-accept %} +#### Reclaiming mannequins with the {% data variables.product.prodname_bbs2gh_cli_short %} + +If your migration source is Bitbucket Server, you can reclaim mannequins with the {% data variables.product.prodname_bbs2gh_cli %}. + +* {% data reusables.enterprise-migration-tool.add-pat-to-reclaim-mannequins %} For {% data variables.product.pat_generic %} requirements, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/migrating-from-bitbucket-server-to-github-enterprise-cloud/managing-access-for-a-migration-from-bitbucket-server#required-scopes-for-personal-access-tokens)." +* {% data reusables.enterprise-migration-tool.add-target-api-url %} + +{% data reusables.enterprise-migration-tool.create-csv-mannequins %} + + * To generate a CSV file with a list of mannequins for an organization, use the `gh bbs2gh generate-mannequin-csv` command, replacing DESTINATION with the destination organization and FILENAME with a file name for the resulting CSV file. + + {% data reusables.enterprise-migration-tool.include-reclaimed %} + + ```shell copy + gh bbs2gh generate-mannequin-csv --github-org DESTINATION --output FILENAME.csv + ``` + + {% data reusables.enterprise-migration-tool.edit-csv %} +1. To reclaim mannequins, use the `gh bbs2gh reclaim-mannequin` command. + + {% data reusables.enterprise-migration-tool.reclaim-bulk-csv %} + + ```shell copy + gh bbs2gh reclaim-mannequin --github-org DESTINATION --csv FILENAME.csv + ``` + + {% data reusables.enterprise-migration-tool.reclaim-individual-mannequin %} + + ```shell copy + gh bbs2gh reclaim-mannequin --github-org DESTINATION --mannequin-user MANNEQUIN --target-user USERNAME + ``` + +{% data reusables.enterprise-migration-tool.mannequin-reclaim-must-accept %} + ### Reclaiming mannequins in your browser {% data reusables.profile.access_org %} From e44344fcc8765041210b1ac17ecd00fae140d74d Mon Sep 17 00:00:00 2001 From: hubwriter Date: Mon, 6 Jan 2025 11:28:26 +0000 Subject: [PATCH 14/17] Remove mention of JetBrains from Codespaces docs (#53683) Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> --- .../creating-a-codespace-for-a-repository.md | 3 - .../deleting-a-codespace.md | 2 +- .../developing-in-a-codespace.md | 63 +-------- .../forwarding-ports-in-your-codespace.md | 38 ++---- .../developing-in-a-codespace/index.md | 1 - .../opening-an-existing-codespace.md | 17 +-- .../stopping-and-starting-a-codespace.md | 18 --- ...github-codespaces-in-your-jetbrains-ide.md | 121 ------------------ .../using-source-control-in-your-codespace.md | 71 +--------- .../codespaces/getting-started/deep-dive.md | 20 +-- .../codespaces/getting-started/quickstart.md | 1 - content/codespaces/guides.md | 1 - content/codespaces/index.md | 3 +- content/codespaces/overview.md | 2 +- content/codespaces/reference/index.md | 2 - ...-github-codespaces-plugin-for-jetbrains.md | 56 -------- ...ur-default-editor-for-github-codespaces.md | 11 -- .../troubleshooting/github-codespaces-logs.md | 27 ---- ...oubleshooting-github-codespaces-clients.md | 86 ------------- .../application-installed-locally.md | 2 +- .../codespaces-jetbrains-beta-note.md | 3 - .../jetbrains-open-codespace-plugin.md | 3 - .../linking-to-an-existing-codespace.md | 1 - .../opening-codespace-in-jetbrains.md | 27 ---- ...jetbrains.md => port-forwarding-adding.md} | 0 ...-jetbrains.md => port-forwarding-intro.md} | 0 ...tbrains.md => port-forwarding-labeling.md} | 0 ...etbrains.md => port-forwarding-sharing.md} | 0 .../rebuilding-container-procedures.md | 2 +- 29 files changed, 23 insertions(+), 558 deletions(-) delete mode 100644 content/codespaces/developing-in-a-codespace/using-github-codespaces-in-your-jetbrains-ide.md delete mode 100644 content/codespaces/reference/using-the-github-codespaces-plugin-for-jetbrains.md delete mode 100644 data/reusables/codespaces/codespaces-jetbrains-beta-note.md delete mode 100644 data/reusables/codespaces/jetbrains-open-codespace-plugin.md delete mode 100644 data/reusables/codespaces/opening-codespace-in-jetbrains.md rename data/reusables/codespaces/{port-forwarding-adding-non-jetbrains.md => port-forwarding-adding.md} (100%) rename data/reusables/codespaces/{port-forwarding-intro-non-jetbrains.md => port-forwarding-intro.md} (100%) rename data/reusables/codespaces/{port-forwarding-labeling-non-jetbrains.md => port-forwarding-labeling.md} (100%) rename data/reusables/codespaces/{port-forwarding-sharing-non-jetbrains.md => port-forwarding-sharing.md} (100%) diff --git a/content/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository.md b/content/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository.md index 129814286939..b63b7ffc06f5 100644 --- a/content/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository.md +++ b/content/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository.md @@ -42,9 +42,6 @@ Organizations can enable members and outside collaborators to create and use cod {% data reusables.codespaces.starting-new-project-template %} For more information, see [AUTOTITLE](/codespaces/developing-in-a-codespace/creating-a-codespace-from-a-template). -> [!NOTE] -> If you use a JetBrains IDE, you can use {% data variables.product.prodname_cli %} to create a codespace. You can then use the JetBrains Gateway application to open the codespace in a JetBrains IDE. For more information, see [AUTOTITLE](/codespaces/developing-in-a-codespace/using-github-codespaces-in-your-jetbrains-ide). - If you create a codespace from a repository, the codespace will be associated with a specific branch, which cannot be empty. You can create more than one codespace per repository or even per branch. {% data reusables.codespaces.you-can-see-all-your-codespaces %} diff --git a/content/codespaces/developing-in-a-codespace/deleting-a-codespace.md b/content/codespaces/developing-in-a-codespace/deleting-a-codespace.md index 94eb74845b6b..c34c52aed15e 100644 --- a/content/codespaces/developing-in-a-codespace/deleting-a-codespace.md +++ b/content/codespaces/developing-in-a-codespace/deleting-a-codespace.md @@ -28,7 +28,7 @@ You can manually delete a codespace in a variety of ways: Use the tabs at the top of this article to display instructions for each of these ways of deleting a codespace. > [!NOTE] -> You can't delete a codespace from within the JetBrains Gateway, or the JetBrains client application, or from within JupyterLab. +> You can't delete a codespace from within JupyterLab. ## Why you should delete unused codespaces diff --git a/content/codespaces/developing-in-a-codespace/developing-in-a-codespace.md b/content/codespaces/developing-in-a-codespace/developing-in-a-codespace.md index b5f4d69a41c4..0bc22bcfd116 100644 --- a/content/codespaces/developing-in-a-codespace/developing-in-a-codespace.md +++ b/content/codespaces/developing-in-a-codespace/developing-in-a-codespace.md @@ -1,6 +1,6 @@ --- title: Developing in a codespace -intro: 'You can work in a codespace using your browser, {% data variables.product.prodname_vscode %}, a JetBrains IDE, or in a command shell.' +intro: 'You can work in a codespace using your browser, {% data variables.product.prodname_vscode %}, or in a command shell.' redirect_from: - /github/developing-online-with-github-codespaces/developing-in-a-codespace - /github/developing-online-with-codespaces/developing-in-a-codespace @@ -16,12 +16,6 @@ topics: shortTitle: Develop in a codespace --- -{% jetbrains_beta %} - -{% data reusables.codespaces.codespaces-jetbrains-beta-note %} - -{% endjetbrains_beta %} - ## About development with {% data variables.product.prodname_github_codespaces %} {% ifversion ghec %} @@ -33,7 +27,6 @@ shortTitle: Develop in a codespace You can develop code in a codespace using your choice of tool: * A command shell, via an SSH connection initiated using {% data variables.product.prodname_cli %} -* One of the JetBrains IDEs, via the JetBrains Gateway * The {% data variables.product.prodname_vscode %} desktop application * A browser-based version of {% data variables.product.prodname_vscode %} @@ -76,60 +69,6 @@ For troubleshooting information, see [AUTOTITLE](/codespaces/troubleshooting/tro {% endvscode %} -{% jetbrains_beta %} - -The tabs in this article allow you to switch between information for each of these ways of working. You're currently on the tab for JetBrains IDEs. - -## Working in a codespace in a JetBrains IDE - -To use {% data variables.product.prodname_github_codespaces %} with a JetBrains IDE you must have already installed JetBrains Gateway. For information about installing JetBrains Gateway, see [the JetBrains website](https://www.jetbrains.com/remote-development/gateway/). - -You can work in a codespace using your choice of JetBrains IDE. After creating a codespace, you can use the JetBrains Gateway application to open the codespace in your preferred IDE. - -You can edit code, debug, and use Git commands while developing in a codespace with your JetBrains IDE. For more information about the various JetBrains IDEs, see the [JetBrains documentation](https://www.jetbrains.com/help/). - -### IntelliJ IDEA user interface - -Within the {% data variables.product.prodname_github_codespaces %} documentation we use IntelliJ IDEA as a representative JetBrains IDE. Different JetBrains IDEs may have different layouts. - -![Annotated screenshot of the six main components of the user interface for JetBrains IntelliJ IDEA.](/assets/images/help/codespaces/jetbrains-gui-with-callouts.png) - -The main components of the user interface are: - -1. **Navigation bar** - This displays the path to the currently selected file or directory. Use the buttons to the right of the navigation bar to perform various actions, including building, running, or debugging the project, or running Git commands to commit and push your changes. -1. **Project tool window** - This shows you the structure of your project and allows you to open files in the editor. -1. **{% data variables.product.prodname_github_codespaces %} tool window** - This is displayed by clicking the {% data variables.product.prodname_github_codespaces %} plugin in the bar to the left of the tool window. It displays information about your codespace, including its display name and machine type. The buttons at the top of this tool window allow you to: - * Refresh the details in the tool window for the active codespace - * Display the "Your codespaces" web page - * View the codespace creation logs -1. **Editor** - This is where you edit your files. You can right-click the tab for a file to access options such as moving the tab to a new window. -1. **Terminal** - This is displayed by clicking **Terminal** in the tool window bar at the bottom of the main window (just above the status bar). The integrated terminal allows you to perform command-line tasks without having to switch to a dedicated terminal application. -1. **Status bar** - Hover over the icon at the left of the status bar to see a list of tools. Click the icon to hide or show the tool window bars. The right side of the status bar shows information about the project, including the current Git branch. - -For more information about the IntelliJ IDEA user interface, see the [JetBrains documentation for IntelliJ IDEA](https://www.jetbrains.com/help/idea/guided-tour-around-the-user-interface.html). - -### Customizing the codespaces for a repository - -You can customize the codespaces that are created for a repository by creating or updating the dev container configuration for the repository. You can do this from within a codespace. After you change a dev container configuration, you can apply the changes to the current codespace by rebuilding the Docker container for the codespace. For more information, see [AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers). - -### Personalizing your codespace - -You can use a [dotfiles](https://dotfiles.github.io/tutorials/) repository to personalize aspects of the codespace environment for any codespace that you create. For more information, see [AUTOTITLE](/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account#dotfiles). - -### Committing your changes - -Once you've made changes to your codespace, either new code or configuration changes, you'll want to commit and push your changes. Pushing changes to a repository ensures that anyone else who creates a codespace from this repository has the same configuration. This also means that any customization you do, to modify the configuration of codespaces created for a repository, will be available to everybody who uses the repository. - -For more information, see [AUTOTITLE](/codespaces/developing-in-a-codespace/using-source-control-in-your-codespace#committing-your-changes). - -## Further reading - -* [AUTOTITLE](/codespaces/developing-in-a-codespace/using-github-codespaces-in-your-jetbrains-ide) -* [AUTOTITLE](/codespaces/reference/using-the-github-codespaces-plugin-for-jetbrains) -* [AUTOTITLE](/codespaces/troubleshooting/troubleshooting-github-codespaces-clients) - -{% endjetbrains_beta %} - {% cli %} The tabs in this article allow you to switch between information for each of these ways of working. You're currently on the tab for {% data variables.product.prodname_cli %}. diff --git a/content/codespaces/developing-in-a-codespace/forwarding-ports-in-your-codespace.md b/content/codespaces/developing-in-a-codespace/forwarding-ports-in-your-codespace.md index 638f72b07c5e..0bb790dd03f3 100644 --- a/content/codespaces/developing-in-a-codespace/forwarding-ports-in-your-codespace.md +++ b/content/codespaces/developing-in-a-codespace/forwarding-ports-in-your-codespace.md @@ -15,19 +15,13 @@ topics: - Developer --- -{% jetbrains_beta %} - -{% data reusables.codespaces.codespaces-jetbrains-beta-note %} - -{% endjetbrains_beta %} - ## About forwarded ports Port forwarding gives you access to TCP ports running within your codespace. For example, if you're running a web application on a particular port in your codespace, you can forward that port. This allows you to access the application from the browser on your local machine for testing and debugging. {% webui %} -{% data reusables.codespaces.port-forwarding-intro-non-jetbrains %} +{% data reusables.codespaces.port-forwarding-intro %} {% data reusables.codespaces.navigate-to-ports-tab %} 1. Under the list of ports, click **Add port**. @@ -48,7 +42,7 @@ By default, {% data variables.product.prodname_github_codespaces %} forwards por 1. Select the protocol needed for this port. The protocol that you select will be remembered for this port for the lifetime of the codespace. -{% data reusables.codespaces.port-forwarding-sharing-non-jetbrains %} +{% data reusables.codespaces.port-forwarding-sharing %} {% data reusables.codespaces.navigate-to-ports-tab %} 1. Right-click the port that you want to share, click the **Port Visibility**, then click **Private to Organization** or **Public**. @@ -64,14 +58,14 @@ By default, {% data variables.product.prodname_github_codespaces %} forwards por {% data reusables.codespaces.using-tools-to-access-ports-1 %} {% data reusables.codespaces.find-address-and-token %} {% data reusables.codespaces.using-tools-to-access-ports-2 %} -{% data reusables.codespaces.port-forwarding-adding-non-jetbrains %} -{% data reusables.codespaces.port-forwarding-labeling-non-jetbrains %} +{% data reusables.codespaces.port-forwarding-adding %} +{% data reusables.codespaces.port-forwarding-labeling %} {% endwebui %} {% vscode %} -{% data reusables.codespaces.port-forwarding-intro-non-jetbrains %} +{% data reusables.codespaces.port-forwarding-intro %} {% data reusables.codespaces.navigate-to-ports-tab %} 1. Under the list of ports, click **Add port**. @@ -81,7 +75,7 @@ By default, {% data variables.product.prodname_github_codespaces %} forwards por ![Screenshot of the number 3000 being entered into the port number field for a new forwarded port.](/assets/images/help/codespaces/port-number-text-box.png) -{% data reusables.codespaces.port-forwarding-sharing-non-jetbrains %} +{% data reusables.codespaces.port-forwarding-sharing %} {% data reusables.codespaces.navigate-to-ports-tab %} @@ -98,8 +92,8 @@ By default, {% data variables.product.prodname_github_codespaces %} forwards por {% data reusables.codespaces.using-tools-to-access-ports-1 %} {% data reusables.codespaces.find-address-and-token %} {% data reusables.codespaces.using-tools-to-access-ports-2 %} -{% data reusables.codespaces.port-forwarding-adding-non-jetbrains %} -{% data reusables.codespaces.port-forwarding-labeling-non-jetbrains %} +{% data reusables.codespaces.port-forwarding-adding %} +{% data reusables.codespaces.port-forwarding-labeling %} {% endvscode %} @@ -117,7 +111,7 @@ For more information about this command, see [the {% data variables.product.prod To see details of forwarded ports enter `gh codespace ports` and then choose a codespace. -{% data reusables.codespaces.port-forwarding-sharing-non-jetbrains %} +{% data reusables.codespaces.port-forwarding-sharing %} To change the visibility of a forwarded port, use the `gh codespace ports visibility` subcommand. {% data reusables.codespaces.port-visibility-settings %} @@ -172,21 +166,11 @@ Copy the address and paste it somewhere for later use. ``` {% data reusables.codespaces.using-tools-to-access-ports-2 %} -{% data reusables.codespaces.port-forwarding-adding-non-jetbrains %} -{% data reusables.codespaces.port-forwarding-labeling-non-jetbrains %} +{% data reusables.codespaces.port-forwarding-adding %} +{% data reusables.codespaces.port-forwarding-labeling %} ### Seeing port labels on the command line You can see the port labels when you list the forwarded ports for a codespace. To do this, use the `gh codespace ports` command and then select a codespace. {% endcli %} - -{% jetbrains_beta %} - -## Forwarding a port - -For information on how to forward a port in a codespace to a port on your local machine, see the "Port forwarding" section of the [Security model](https://www.jetbrains.com/help/idea/security-model.html#port_forwarding) article in the JetBrains documentation. - -Alternatively, you can use {% data variables.product.prodname_cli %} to forward a port. For more information, click the "{% data variables.product.prodname_cli %}" tab at the top of this page. - -{% endjetbrains_beta %} diff --git a/content/codespaces/developing-in-a-codespace/index.md b/content/codespaces/developing-in-a-codespace/index.md index f4b62050b870..f8f54b7daa68 100644 --- a/content/codespaces/developing-in-a-codespace/index.md +++ b/content/codespaces/developing-in-a-codespace/index.md @@ -23,7 +23,6 @@ children: - /connecting-to-a-private-network - /getting-started-with-github-codespaces-for-machine-learning - /using-github-codespaces-in-visual-studio-code - - /using-github-codespaces-in-your-jetbrains-ide - /using-github-codespaces-with-github-cli redirect_from: - /codespaces/developing-in-codespaces diff --git a/content/codespaces/developing-in-a-codespace/opening-an-existing-codespace.md b/content/codespaces/developing-in-a-codespace/opening-an-existing-codespace.md index f9bc037f85b3..d67193f68998 100644 --- a/content/codespaces/developing-in-a-codespace/opening-an-existing-codespace.md +++ b/content/codespaces/developing-in-a-codespace/opening-an-existing-codespace.md @@ -20,13 +20,7 @@ redirect_from: {% endif %} -{% jetbrains_beta %} - -{% data reusables.codespaces.codespaces-jetbrains-beta-note %} - -{% endjetbrains_beta %} - -You can reopen any of your active or stopped codespaces on {% data variables.product.github %}, in a JetBrains IDE, in {% data variables.product.prodname_vscode %}, or by using {% data variables.product.prodname_cli %}. You can't reopen a codespace that has been deleted. See [AUTOTITLE](/codespaces/getting-started/understanding-the-codespace-lifecycle). +You can reopen any of your active or stopped codespaces on {% data variables.product.github %}, in {% data variables.product.prodname_vscode %}, or by using {% data variables.product.prodname_cli %}. You can't reopen a codespace that has been deleted. See [AUTOTITLE](/codespaces/getting-started/understanding-the-codespace-lifecycle). You can view all your codespaces on the "Your codespaces" page at [github.com/codespaces](https://github.com/codespaces). From this page, you can: @@ -73,7 +67,6 @@ You can bookmark the address of this page if you want to get back to it quickly You can open the codespace in: * Your browser * {% data variables.product.prodname_vscode %} - * JetBrains Gateway * JupyterLab {% data reusables.codespaces.application-installed-locally %} @@ -153,14 +146,6 @@ See [`gh codespace code`](https://cli.github.com/manual/gh_codespace_code) in th {% endcli %} -{% jetbrains_beta %} - -## Reopening an existing codespace - -{% data reusables.codespaces.opening-codespace-in-jetbrains %} - -{% endjetbrains_beta %} - ## Further reading * [AUTOTITLE](/rest/codespaces/organizations) diff --git a/content/codespaces/developing-in-a-codespace/stopping-and-starting-a-codespace.md b/content/codespaces/developing-in-a-codespace/stopping-and-starting-a-codespace.md index c7a8fb1777bf..67ce5dbbbb28 100644 --- a/content/codespaces/developing-in-a-codespace/stopping-and-starting-a-codespace.md +++ b/content/codespaces/developing-in-a-codespace/stopping-and-starting-a-codespace.md @@ -14,12 +14,6 @@ redirect_from: - /codespaces/developing-in-codespaces/stopping-and-starting-a-codespace --- -{% jetbrains_beta %} - -{% data reusables.codespaces.codespaces-jetbrains-beta-note %} - -{% endjetbrains_beta %} - ## About stopping and starting a codespace {% data reusables.codespaces.stopping-a-codespace %} @@ -58,12 +52,6 @@ gh codespace stop {% endvscode %} -{% jetbrains_beta %} - -You can stop a codespace from the "Your codespaces" page (see [the web browser instructions](/codespaces/developing-in-a-codespace/stopping-and-starting-a-codespace?tool=webui#stopping-a-codespace)) or by using {% data variables.product.prodname_cli %} (see [the CLI instructions](/codespaces/developing-in-a-codespace/stopping-and-starting-a-codespace?tool=cli#stopping-a-codespace)). - -{% endjetbrains_beta %} - ## Restarting a codespace {% webui %} @@ -101,12 +89,6 @@ When you restart a codespace you can choose to open it in {% data variables.prod {% endvscode %} -{% jetbrains_beta %} - -{% data reusables.codespaces.opening-codespace-in-jetbrains %} - -{% endjetbrains_beta %} - ## Further reading * [AUTOTITLE](/codespaces/getting-started/understanding-the-codespace-lifecycle) diff --git a/content/codespaces/developing-in-a-codespace/using-github-codespaces-in-your-jetbrains-ide.md b/content/codespaces/developing-in-a-codespace/using-github-codespaces-in-your-jetbrains-ide.md deleted file mode 100644 index e567ed87728d..000000000000 --- a/content/codespaces/developing-in-a-codespace/using-github-codespaces-in-your-jetbrains-ide.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -title: Using GitHub Codespaces in your JetBrains IDE -shortTitle: JetBrains IDEs -intro: You can use the JetBrains Gateway to connect to your codespace and work in your favorite JetBrains IDE. -versions: - fpt: '*' - ghec: '*' -type: how_to -topics: - - Codespaces - - Developer -redirect_from: - - /codespaces/developing-in-codespaces/using-github-codespaces-in-your-jetbrains-ide ---- - -{% data reusables.codespaces.codespaces-jetbrains-beta-note %} - -## About {% data variables.product.prodname_codespaces %} in JetBrains IDEs - -If you use a JetBrains IDE to work on your code, you can take advantage of working in a codespace. You do this by using the JetBrains Gateway application. - -After installing the JetBrains Gateway, you can set JetBrains as your default editor for {% data variables.product.prodname_codespaces %}. If you do, then whenever you open a codespace from {% data variables.product.github %}, the JetBrains Gateway will launch to allow you to choose your JetBrains IDE and connect to the codespace. - -When you work in a codespace, you use the JetBrains thin client application on your local computer. This provides the graphical interface for the full JetBrains IDE of your choice, which runs on the remote virtual machine that hosts your codespace. The thin client is always used, even if the full JetBrains IDE is installed locally. Any local JetBrains IDE settings are imported and used by the thin client. - -> [!NOTE] -> Only existing codespaces are available in the JetBrains Gateway. You can create codespaces in {% data variables.product.github %}, or by using {% data variables.product.prodname_cli %}. For more information, see [AUTOTITLE](/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository). - -### The JetBrains remote development connection process - -The basic process behind using a codespace in your JetBrains IDE is as follows. -1. In the JetBrains Gateway application you select one of your active or stopped codespaces. -1. You then choose which JetBrains IDE you want to use. -1. The selected JetBrains IDE is then downloaded to the remote virtual machine that hosts your codespace and source code. -1. The JetBrains thin client application is then downloaded to your local machine and started. -1. The client application connects to the full backend IDE. -1. You can work on your code in the client application in just the same way you would in a local environment. - -## Prerequisites - -To work in a codespace in a JetBrains IDE you need: - -* A valid JetBrains license -* The JetBrains Gateway application, versions 2023.3.\* or 2024.1.\* -* An existing codespace running on a virtual machine that has at least 4 cores. The codespace must also be running an SSH server. For more information, see [Codespace running an SSH server](#codespace-running-an-ssh-server). - -### JetBrains license - -You must have a JetBrains license that supports the IDE you choose in the JetBrains Gateway. - -### JetBrains Gateway - -You can install and update the JetBrains Gateway from the JetBrains Toolbox application. - -1. Download and install the [JetBrains Toolbox](https://www.jetbrains.com/toolbox-app). -1. Open the JetBrains Toolbox. -1. Find **Gateway** in the list of available tools. - - ![Screenshot of the JetBrains Toolbox with "Gateway" at the bottom of the list of applications. Each application has an "Install" button next to it.](/assets/images/help/codespaces/jetbrains-toolbox.png) - -1. To the right of **Gateway**, click the ellipsis (**...**), then click **Available versions**. -1. In the list of versions, beside a supported version (see [Prerequisites](#prerequisites)), click **Install**. - -### Codespace running an SSH server - -You must have an existing codespace to connect to, and the virtual machine that hosts the codespace must have at least 4 cores. {% data reusables.codespaces.ways-to-create-a-codespace %} For more information, see [AUTOTITLE](/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository). - -{% data reusables.codespaces.ssh-server-installed %} - -For more information about the `devcontainer.json` file and the default container image, see [AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers). - -> [!NOTE] -> For help with connecting to your codespace over SSH, see [AUTOTITLE](/codespaces/troubleshooting/troubleshooting-github-codespaces-clients?tool=jetbrains#ssh-connection-issues). - -## Setting up the JetBrains Gateway - -The first time you use JetBrains Gateway for {% data variables.product.prodname_github_codespaces %}, you must install the {% data variables.product.prodname_codespaces %} plugin. You must also allow the JetBrains Gateway to access {% data variables.product.github %} using your {% data variables.product.prodname_dotcom %} account. - -1. Open the JetBrains Toolbox application. -1. In the list of installed tools, click **Gateway**. -1. Under **Install More Providers** click the **Install** link for {% data variables.product.prodname_github_codespaces %}. - - ![Screenshot of the "Welcome to JetBrains Gateway" page, with "{% data variables.product.prodname_github_codespaces %}" listed under "Install More Providers."](/assets/images/help/codespaces/jetbrains-gateway-initial-view.png) - -1. Click **Connect to Codespace**. - - ![Screenshot of the Gateway with the "Connect to {% data variables.product.prodname_codespaces %}" button.](/assets/images/help/codespaces/jetbrains-gateway-connect.png) - -1. The first time you connect, you're prompted to choose whether you want to allow {% data variables.product.prodname_dotcom %} to collect anonymized usage data, to improve functionality and user experience. Click **Allow** or **Deny**. - - You can change your choice later, if required, in the settings for the {% data variables.product.prodname_github_codespaces %} plugin, which you can access within the JetBrains Gateway settings. - -1. In the "Welcome to JetBrains Gateway" dialog, click **Sign In with {% data variables.product.prodname_dotcom %}**. -1. Click the icon beside the one-time code to copy it. - - ![Screenshot of a one-time login code. The copy icon beside the code is highlighted with a dark orange outline.](/assets/images/help/codespaces/jetbrains-gateway-login-code.png) - -1. Click the login link, below the login code. -1. If you are not currently signed in to {% data variables.product.prodname_dotcom %}, the sign-in page is displayed. - * Enter your details and click **Sign in**. - * Verify your authentication, for example by entering a two-factor authentication code. -1. On the "Device activation" page, paste the copied code and click **Continue**. -1. If you belong to organizations, the "Single sign-on to your organizations" page is displayed. Click **Authorize** beside the organizations you want to authorize the JetBrains Gateway to access, then click **Continue**. -1. On the "Authorize {% data variables.product.prodname_github_codespaces %} for JetBrains" page, click **Authorize {% data variables.product.prodname_dotcom %}**. -1. Return to the JetBrains Gateway application and open a codespace from the list of your currently active or stopped codespaces, see step 3 of the following procedure. - -## Opening a codespace in your JetBrains IDE - -{% data reusables.codespaces.opening-codespace-in-jetbrains %} - - The first time you connect to a codespace, the backend IDE will be downloaded to the remote machine. This may take a few minutes. The next time you connect to the same codespace this step won't be necessary, making the connection process quicker. - - The backend IDE is then started. Again, this step will not be required in future if you are reconnecting to a backend IDE that you have left running. - - The client application is then launched. - -## Further reading - -* [AUTOTITLE](/codespaces/developing-in-a-codespace/developing-in-a-codespace) -* [AUTOTITLE](/codespaces/reference/using-the-github-codespaces-plugin-for-jetbrains) -* [AUTOTITLE](/codespaces/troubleshooting/troubleshooting-github-codespaces-clients?tool=jetbrains) diff --git a/content/codespaces/developing-in-a-codespace/using-source-control-in-your-codespace.md b/content/codespaces/developing-in-a-codespace/using-source-control-in-your-codespace.md index 611c33798b46..c7fb357f6285 100644 --- a/content/codespaces/developing-in-a-codespace/using-source-control-in-your-codespace.md +++ b/content/codespaces/developing-in-a-codespace/using-source-control-in-your-codespace.md @@ -14,12 +14,6 @@ redirect_from: - /codespaces/developing-in-codespaces/using-source-control-in-your-codespace --- -{% jetbrains_beta %} - -{% data reusables.codespaces.codespaces-jetbrains-beta-note %} - -{% endjetbrains_beta %} - ## About source control in {% data variables.product.prodname_github_codespaces %} You can perform all the Git actions you need directly within your codespace. For example, you can fetch changes from a remote repository, switch branches, create a new branch, commit and push changes, and create a pull request. You can use the integrated terminal within your codespace to enter Git commands, or you can click icons and menu options to complete all the most common Git tasks. This guide explains how to use the graphical user interface for source control. @@ -55,7 +49,7 @@ You do not need to fork the repository before you create the codespace. For exam If you make a commit from the codespace, or push a new branch, {% data variables.product.prodname_github_codespaces %} either creates a fork of the repository under your account and links it to your codespace, or it links your codespace to an existing fork if you already have one for the repository. You can then push your changes to the fork and create a pull request to propose the changes to the upstream repository. -If you make a commit from the command line, you will see a prompt asking if you would like to proceed with linking your codespace to a new or existing fork. Enter `y` to proceed. If you commit changes from the **Source Control** view in {% data variables.product.prodname_vscode_shortname %}, or from the navigation bar in a JetBrains IDE, your codespace is automatically linked to a fork without you being prompted. +If you make a commit from the command line, you will see a prompt asking if you would like to proceed with linking your codespace to a new or existing fork. Enter `y` to proceed. If you commit changes from the **Source Control** view in {% data variables.product.prodname_vscode_shortname %}, your codespace is automatically linked to a fork without you being prompted. > [!NOTE] > * If you delete your fork repository, then any codespaces linked to the fork are deleted, even if you originally created them from the upstream repository. @@ -91,66 +85,3 @@ For more information, see [AUTOTITLE](/pull-requests/collaborating-with-pull-req {% data reusables.codespaces.source-control %} {% endvscode %} - -{% jetbrains_beta %} - -## Creating or switching branches - -1. Click the branch name at the right side of the status bar. - - ![Screenshot of the status bar, with the tooltip for the branch name displayed. The branch icon and name, "main," are highlighted with a dark orange outline.](/assets/images/help/codespaces/jetbrains-branch-button.png) - -1. In the pop-up menu, do one of the following: - * **To create a new branch based on the current branch**, click **New Branch**. - - ![Screenshot of the branches pop-up menu with the "New Branch" option selected.](/assets/images/help/codespaces/jetbrains-new-branch-option.png) - - Enter a name for the new branch and click **Create**. - - ![Screenshot of the "Create New Branch" dialog, with "Create" and "Cancel" buttons. "my-branch" has been entered as a branch name.](/assets/images/help/codespaces/jetbrains-create-branch-dialog.png) - - * **To check out an existing branch**, start typing the name of the branch you want to check out. Click the branch from the list, then click **Checkout**. - - ![Screenshot of the branches pop-up menu with the "origin/templates" branch selected and "Checkout" selected in the submenu.](/assets/images/help/codespaces/jetbrains-checkout-submenu.png) - - > [!TIP] - > If someone has recently changed a file on the remote repository, in the branch you switched to, you may not see those changes until you pull the changes into your codespace. - -## Committing your changes - -1. At the right side of the navigation bar, click the check mark. - - ![Screenshot of the navigation bar at the top of the JetBrains client. The check mark icon for committing your changes is highlighted.](/assets/images/help/codespaces/jetbrains-commit-button.png) - -1. In the Commit Changes dialog, enter a commit message. -1. Click **Commit**. - - Alternatively, click the down arrow beside **Commit** and click **Commit and Push**. - - ![Screenshot of the "Commit Changes" dialog showing the "Commit and Push" button.](/assets/images/help/codespaces/jetbrains-commit-and-push.png) - -## Pulling changes from the remote repository - -You can pull changes from the same branch on the remote repository and apply those changes to the copy of the repository you are working on in your codespace. - -1. At the right side of the navigation bar, click the downward pointing arrow. - - ![Screenshot of the navigation bar at the top of the JetBrains client. The downward arrow icon is highlighted with a dark orange outline.](/assets/images/help/codespaces/jetbrains-update-project-button.png) - -1. In the Update Project dialog, choose whether you want to merge or rebase the incoming changes. - - ![Screenshot of the "Update Project" dialog with options to merge or rebase, and a "Don't show again" checkbox.](/assets/images/help/codespaces/jetbrains-update-options.png) - -1. Click **OK**. - -## Pushing changes to your remote repository - -You can push changes you've saved and committed. This applies those changes to the upstream branch on the remote repository. You might want to do this if you're not yet ready to create a pull request, or if you prefer to create a pull request on {% data variables.product.prodname_dotcom %}. - -1. At the right side of the navigation bar, click the upward pointing arrow. - - ![Screenshot of the navigation bar at the top of the JetBrains client. The upward arrow icon is highlighted with a dark orange outline.](/assets/images/help/codespaces/jetbrains-push-button.png) - -1. In the Push Commits dialog, click **Push**. - -{% endjetbrains_beta %} diff --git a/content/codespaces/getting-started/deep-dive.md b/content/codespaces/getting-started/deep-dive.md index f55b168176aa..e7cbc28eef74 100644 --- a/content/codespaces/getting-started/deep-dive.md +++ b/content/codespaces/getting-started/deep-dive.md @@ -56,7 +56,6 @@ When your container has been created and any other initialization has run, you'l * Your web browser * [{% data variables.product.prodname_vscode %}](/codespaces/developing-in-a-codespace/using-github-codespaces-in-visual-studio-code) -* [A JetBrains IDE](/codespaces/developing-in-a-codespace/using-github-codespaces-in-your-jetbrains-ide) * [{% data variables.product.prodname_cli %}](/codespaces/developing-in-a-codespace/using-github-codespaces-with-github-cli) ### Step 4: Post-creation setup @@ -89,7 +88,6 @@ To stop your codespace you can * In the browser: on your list of codespaces at [https://github.com/codespaces](https://github.com/codespaces), click the ellipsis (**...**) to the right of the codespace you want to stop and click **Stop codespace**. * In {% data variables.product.prodname_vscode_shortname %}: open the {% data variables.product.prodname_vscode_command_palette %} - for example, by pressing Ctrl+Shift+P (Windows/Linux) or Shift+Command+P (Mac) - type `Codespaces: stop` then press Enter. For more information, see [AUTOTITLE](/codespaces/reference/using-the-vs-code-command-palette-in-codespaces#suspending-or-stopping-a-codespace). -* In the JetBrains client, click the stop button at the top of the {% data variables.product.prodname_github_codespaces %} tool window. For more information, see the "JetBrains IDEs" tab of [AUTOTITLE](/codespaces/developing-in-a-codespace/stopping-and-starting-a-codespace). * In a terminal window: use the {% data variables.product.prodname_cli %} command `gh codespace stop`. For more information, see [AUTOTITLE](/codespaces/developing-in-a-codespace/using-github-codespaces-with-github-cli#gh-commands-for-github-codespaces). If you exit your codespace without running the stop command (for example, by closing the browser tab), or if you leave the codespace running without interaction, the codespace and its running processes will continue for the duration of the inactivity timeout period. @@ -112,7 +110,7 @@ Running your application when you first land in your codespace can make for a fa ## Committing and pushing your changes -Git is installed by default in your codespace and so you can rely on your existing Git workflow. You can work with Git in your codespace either via the Terminal or by using the source control features of {% data variables.product.prodname_vscode_shortname %} or JetBrains. +Git is installed by default in your codespace and so you can rely on your existing Git workflow. You can work with Git in your codespace either via the Terminal or by using the source control features of {% data variables.product.prodname_vscode_shortname %}. If you're working with an existing repository, you can create a codespace from any branch, commit, or pull request in the repository, or you can switch to a new or existing branch from within your active codespace. Because {% data variables.product.prodname_github_codespaces %} is designed to be ephemeral, you can use it as an isolated environment to experiment, check a teammate's pull request, or fix merge conflicts. @@ -125,9 +123,9 @@ For more information, see [AUTOTITLE](/codespaces/developing-in-a-codespace/usin > [!NOTE] > Commits from your codespace will be attributed to the name and public email configured at https://github.com/settings/profile. A token scoped to the repository, included in the environment as `GITHUB_TOKEN`, and your GitHub credentials will be used to authenticate. -## Personalizing your codespace with extensions or plugins +## Personalizing your codespace with extensions -You can add plugins and extensions within a codespace to personalize your experience in JetBrains and {% data variables.product.prodname_vscode_shortname %} respectively. +You can add extensions within a codespace to personalize your experience in {% data variables.product.prodname_vscode_shortname %}. ### {% data variables.product.prodname_vscode_shortname %} extensions @@ -135,18 +133,6 @@ If you work on your codespaces in the {% data variables.product.prodname_vscode_ If you already use {% data variables.product.prodname_vscode_shortname %}, you can use [Settings Sync](https://code.visualstudio.com/docs/editor/settings-sync) to automatically sync extensions, settings, themes, and keyboard shortcuts between your local instance and any codespaces you create. -### JetBrains plugins - -If you work on your codespaces in a JetBrains IDE, you can add plugins from the JetBrains Marketplace. - -1. Click **JetBrains Client**, then click **Preferences**. -1. In the Preferences dialog, click either **Plugins On Host** to install a plugin in the full JetBrains IDE that's running remotely, or **Plugins** to install a plugin on the local client, for example to change the user interface theme. -1. Click the **Marketplace** tab. - - ![Screenshot of the "Preferences" dialog, with the "Marketplace" tab displayed. The "Plugins On Host" option is highlighted with a dark orange outline.](/assets/images/help/codespaces/jetbrains-preferences-plugins.png) - -1. Click **Install** beside the required plugin. - ## About the directory structure of a codespace {% data reusables.codespaces.workspaces-directory %} For more information on the `/tmp` directory, see [AUTOTITLE](/codespaces/developing-in-a-codespace/persisting-environment-variables-and-temporary-files#preventing-temporary-files-from-being-automatically-deleted). diff --git a/content/codespaces/getting-started/quickstart.md b/content/codespaces/getting-started/quickstart.md index 9a9b9695893b..66f53c48e242 100644 --- a/content/codespaces/getting-started/quickstart.md +++ b/content/codespaces/getting-started/quickstart.md @@ -118,7 +118,6 @@ You've successfully created, personalized, and run your first application within * [AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/enabling-or-disabling-github-codespaces-for-your-organization) * [AUTOTITLE](/codespaces/developing-in-a-codespace/using-github-codespaces-in-visual-studio-code) -* [AUTOTITLE](/codespaces/developing-in-a-codespace/using-github-codespaces-in-your-jetbrains-ide) * [AUTOTITLE](/codespaces/developing-in-a-codespace/using-github-codespaces-with-github-cli) * [AUTOTITLE](/codespaces/setting-your-user-preferences/setting-your-default-editor-for-github-codespaces). * [AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/managing-the-cost-of-github-codespaces-in-your-organization) diff --git a/content/codespaces/guides.md b/content/codespaces/guides.md index 396ec7aa2708..a79512d9fca4 100644 --- a/content/codespaces/guides.md +++ b/content/codespaces/guides.md @@ -32,7 +32,6 @@ includeGuides: - /codespaces/developing-in-a-codespace/stopping-and-starting-a-codespace - /codespaces/developing-in-a-codespace/working-collaboratively-in-a-codespace - /codespaces/developing-in-a-codespace/using-github-codespaces-in-visual-studio-code - - /codespaces/developing-in-a-codespace/using-github-codespaces-in-your-jetbrains-ide - /codespaces/developing-in-a-codespace/using-github-codespaces-with-github-cli - /codespaces/developing-in-a-codespace/using-source-control-in-your-codespace - /codespaces/developing-in-a-codespace/using-github-codespaces-for-pull-requests diff --git a/content/codespaces/index.md b/content/codespaces/index.md index 32c007c711d9..0b7711367643 100644 --- a/content/codespaces/index.md +++ b/content/codespaces/index.md @@ -19,7 +19,6 @@ featuredLinks: - /codespaces/developing-in-a-codespace/opening-an-existing-codespace - /codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account - /codespaces/developing-in-a-codespace/using-github-codespaces-in-visual-studio-code - - /codespaces/developing-in-a-codespace/using-github-codespaces-in-your-jetbrains-ide popular: - /codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/setting-up-your-nodejs-project-for-codespaces - /codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/setting-up-your-python-project-for-codespaces @@ -37,6 +36,8 @@ communityRedirect: redirect_from: - /github/developing-online-with-github-codespaces - /github/developing-online-with-codespaces + - /codespaces/developing-in-a-codespace/using-github-codespaces-in-your-jetbrains-ide + - /codespaces/reference/using-the-github-codespaces-plugin-for-jetbrains layout: product-landing versions: fpt: '*' diff --git a/content/codespaces/overview.md b/content/codespaces/overview.md index 1dcfbf5ad2bf..a09ecb8c5992 100644 --- a/content/codespaces/overview.md +++ b/content/codespaces/overview.md @@ -31,7 +31,7 @@ Each codespace you create is hosted by {% data variables.product.prodname_dotcom By default, the codespace development environment is created from an Ubuntu Linux image that includes a selection of popular languages and tools, but you can use an image based on a Linux distribution of your choice and configure it for your particular requirements. Regardless of your local operating system, your codespace will run in a Linux environment. Windows and macOS are not supported operating systems for the remote development container. -You can connect to your codespaces from your browser, from {% data variables.product.prodname_vscode %}, from the JetBrains Gateway application, or by using {% data variables.product.prodname_cli %}. When you connect, you are placed within the Docker container. You have limited access to the outer Linux virtual machine host. +You can connect to your codespaces from your browser, from {% data variables.product.prodname_vscode %}, or by using {% data variables.product.prodname_cli %}. When you connect, you are placed within the Docker container. You have limited access to the outer Linux virtual machine host. ![Diagram showing the relationship between a code editor and a codespace running on an Azure virtual machine.](/assets/images/help/codespaces/codespaces-diagram.png) diff --git a/content/codespaces/reference/index.md b/content/codespaces/reference/index.md index 5df97e3f838f..dc25d253d4c0 100644 --- a/content/codespaces/reference/index.md +++ b/content/codespaces/reference/index.md @@ -7,11 +7,9 @@ versions: children: - /allowing-your-codespace-to-access-a-private-registry - /using-github-copilot-in-github-codespaces - - /using-the-github-codespaces-plugin-for-jetbrains - /using-the-vs-code-command-palette-in-codespaces - /security-in-github-codespaces - /disaster-recovery-for-github-codespaces redirect_from: - /codespaces/codespaces-reference --- - diff --git a/content/codespaces/reference/using-the-github-codespaces-plugin-for-jetbrains.md b/content/codespaces/reference/using-the-github-codespaces-plugin-for-jetbrains.md deleted file mode 100644 index e54e3d97d696..000000000000 --- a/content/codespaces/reference/using-the-github-codespaces-plugin-for-jetbrains.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: Using the GitHub Codespaces plugin for JetBrains -shortTitle: Plugin for JetBrains -intro: 'You can use the {% data variables.product.prodname_github_codespaces %} plugin for the JetBrains client application to find out about your codespace or to stop your codespace when you''ve finished working.' -versions: - fpt: '*' - ghec: '*' -type: reference -topics: - - Codespaces -redirect_from: - - /codespaces/codespaces-reference/using-the-github-codespaces-plugin-for-jetbrains ---- - -{% data reusables.codespaces.codespaces-jetbrains-beta-note %} - -## About the {% data variables.product.prodname_github_codespaces %} plugin - -The JetBrains client application is launched when you connect to a codespace from the JetBrains Gateway application. It allows you to use {% data variables.product.prodname_github_codespaces %} with your favorite JetBrains IDE. For more information, see [AUTOTITLE](/codespaces/developing-in-a-codespace/using-github-codespaces-in-your-jetbrains-ide). - -The {% data variables.product.prodname_github_codespaces %} plugin is already installed in the JetBrains client when you connect to a codespace from the JetBrains Gateway. The plugin adds the {% data variables.product.prodname_github_codespaces %} tool window to the user interface. - -Click **{% data variables.product.prodname_github_codespaces %}** at the bottom left of the JetBrains client's application window to open the {% data variables.product.prodname_github_codespaces %} tool window. - -![Screenshot of the {% data variables.product.prodname_github_codespaces %} tool window. The "{% data variables.product.prodname_github_codespaces %}" tool window selector is highlighted with an orange outline.](/assets/images/help/codespaces/jetbrains-codespaces-tool-window.png) - -## Using the {% data variables.product.prodname_github_codespaces %} tool window - -The {% data variables.product.prodname_github_codespaces %} tool window shows: -* The repository from which you created this codespace -* The display name of the codespace -* The current branch -* The machine specifications -* The time for which this codespace can remain idle before it is automatically stopped -* The age of the codespace -* The period for which a stopped codespace will be retained before it is automatically deleted - -The icons at the top of the {% data variables.product.prodname_github_codespaces %} tool window provide the following functions. - -* **Refresh active codespace** - - ![Screenshot of the {% data variables.product.prodname_github_codespaces %} tool window. A refresh icon, which refreshes the active code space, is highlighted.](/assets/images/help/codespaces/jetbrains-plugin-icon-refresh.png) - - Refresh the details in the {% data variables.product.prodname_github_codespaces %} tool window. For example, if you used {% data variables.product.prodname_cli %} to change the display name, you could click this button to show the new name. - -* **Manage your codespaces from the web** - - ![Screenshot of the {% data variables.product.prodname_github_codespaces %} tool window. A world icon, which manages {% data variables.product.prodname_github_codespaces %} from the web, is highlighted.](/assets/images/help/codespaces/jetbrains-plugin-icon-index.png) - - Open your list of codespaces at https://github.com/codespaces. - -* **View the codespace creation log** - - ![Screenshot of the {% data variables.product.prodname_github_codespaces %} tool window. A document icon, which allows you to view a code space creation log, is highlighted.](/assets/images/help/codespaces/jetbrains-plugin-icon-log.png) - - Open the codespace creation log in the editor window. For more information, see [AUTOTITLE](/codespaces/troubleshooting/github-codespaces-logs). diff --git a/content/codespaces/setting-your-user-preferences/setting-your-default-editor-for-github-codespaces.md b/content/codespaces/setting-your-user-preferences/setting-your-default-editor-for-github-codespaces.md index dc78611be260..5eb31f1c3b26 100644 --- a/content/codespaces/setting-your-user-preferences/setting-your-default-editor-for-github-codespaces.md +++ b/content/codespaces/setting-your-user-preferences/setting-your-default-editor-for-github-codespaces.md @@ -17,15 +17,12 @@ type: how_to On the settings page, you can set your editor preference so that when you create a codespace, or open an existing codespace, it is opened in your choice of: * {% data variables.product.prodname_vscode %} (desktop application) * {% data variables.product.prodname_vscode %} (web client application) -* JetBrains Gateway - for opening codespaces in a JetBrains IDE * JupyterLab - the web interface for Project Jupyter {% data reusables.codespaces.template-codespaces-default-editor %} If you want to use {% data variables.product.prodname_vscode %} as your default editor for {% data variables.product.prodname_github_codespaces %}, you need to install {% data variables.product.prodname_vscode %} and the {% data variables.product.prodname_github_codespaces %} extension for {% data variables.product.prodname_vscode %}. For more information, see the [download page for {% data variables.product.prodname_vscode %}](https://code.visualstudio.com/download/) and the [{% data variables.product.prodname_github_codespaces %} extension on the {% data variables.product.prodname_vscode %} marketplace](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces). -If you want to work on a codespace in a JetBrains IDE you must install the JetBrains Gateway. For more information, see [AUTOTITLE](/codespaces/developing-in-a-codespace/using-github-codespaces-in-your-jetbrains-ide). - ## Setting your default editor {% data reusables.user-settings.access_settings %} @@ -40,14 +37,6 @@ If you want to work on a codespace in a JetBrains IDE you must install the JetBr You may need to allow access to both your browser and {% data variables.product.prodname_vscode %} for it to open successfully.

- * If you choose **JetBrains Gateway**, the Gateway application will automatically open when you next create or open a codespace. - - The first time you open a codespace this way you must give permission to open the application. - - The Gateway application will open and the codespace will then be automatically selected. You can then choose a JetBrains IDE, if you have not previously done so, and click **Connect** to open the codespace in the JetBrains client. For more information, see [AUTOTITLE](/codespaces/developing-in-a-codespace/using-github-codespaces-in-your-jetbrains-ide). - - To connect to a codespace from the Gateway application, you must have an SSH server running on the codespace. {% indented_data_reference reusables.codespaces.ssh-server-installed spaces=5 %} - * If you choose **JupyterLab**, the JupyterLab application must be installed in the codespaces you open. {% data reusables.codespaces.jupyterlab-in-default-image %} ## Further reading diff --git a/content/codespaces/troubleshooting/github-codespaces-logs.md b/content/codespaces/troubleshooting/github-codespaces-logs.md index 69be947f6348..5fca4f6e4006 100644 --- a/content/codespaces/troubleshooting/github-codespaces-logs.md +++ b/content/codespaces/troubleshooting/github-codespaces-logs.md @@ -13,12 +13,6 @@ redirect_from: - /codespaces/troubleshooting/codespaces-logs --- -{% jetbrains_beta %} - -{% data reusables.codespaces.codespaces-jetbrains-beta-note %} - -{% endjetbrains_beta %} - Information on {% data variables.product.prodname_github_codespaces %} is output to various logs: {% webui %} @@ -50,14 +44,6 @@ Other logs are available if you are using {% data variables.product.prodname_git {% endcli %} -{% jetbrains_beta %} - -* Creation logs - -Other logs are available if you are using {% data variables.product.prodname_github_codespaces %} in {% data variables.product.prodname_vscode_shortname %} or in your web browser. Click the tabs above for details. - -{% endjetbrains_beta %} - {% webui %} {% data reusables.codespaces.codespace-logs %} @@ -159,19 +145,6 @@ The following instructions are for Chrome. The steps for other browsers are simi {% endwebui %} -{% jetbrains_beta %} - -{% data reusables.codespaces.jetbrains-open-codespace-plugin %} -1. In the {% data variables.product.prodname_github_codespaces %} tool window, click the log icon. - - ![Screenshot of the log button (a book symbol).](/assets/images/help/codespaces/jetbrains-plugin-icon-log.png) - -## JetBrains logs - -You can download logs for the remote JetBrains IDE and the local client application by going to the **Help** menu in the JetBrains client application and clicking **Collect Host and Client Logs**. - -{% endjetbrains_beta %} - ## Further reading * [AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/reviewing-your-organizations-audit-logs-for-github-codespaces) diff --git a/content/codespaces/troubleshooting/troubleshooting-github-codespaces-clients.md b/content/codespaces/troubleshooting/troubleshooting-github-codespaces-clients.md index a3a4c01cd9c5..6724dea53775 100644 --- a/content/codespaces/troubleshooting/troubleshooting-github-codespaces-clients.md +++ b/content/codespaces/troubleshooting/troubleshooting-github-codespaces-clients.md @@ -12,12 +12,6 @@ redirect_from: - /codespaces/troubleshooting/troubleshooting-codespaces-clients --- -{% jetbrains_beta %} - -{% data reusables.codespaces.codespaces-jetbrains-beta-note %} - -{% endjetbrains_beta %} - {% webui %} ## Troubleshooting the {% data variables.product.prodname_vscode %} web client @@ -67,83 +61,3 @@ If the problem isn't fixed in {% data variables.product.prodname_vscode %} Stabl {% data reusables.codespaces.troubleshooting-simple-browser %} {% endvscode %} - -{% jetbrains_beta %} - -## Troubleshooting JetBrains IDEs - -### Performance issues - -A {% data variables.product.prodname_github_codespaces %} machine type with at least 4 cores is recommended for running any of the JetBrains IDEs. For more information, see [AUTOTITLE](/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace). - -If you are using a machine with 4 or more cores and the performance you are experiencing in JetBrains feels a little sluggish, you may need to increase the maximum Java heap size. - -The recommended heap size varies according to the machine type of your codespace. - -| Machine type | Maximum heap size | -| -------------------- | ----------------- | -| 4 core, 16 GB RAM | 2048 MiB | -| 8 core, 32 GB RAM | 4096 MiB | -| 16 cores, 64 GB RAM | 8192 MiB | -| 32 cores, 128 GB RAM | 16,384 MiB | - -If the heap size is below the recommended value, a message is displayed when your codespace starts, suggesting that you increase the heap size. You can click the link in the message to increase the heap size automatically. - -![Screenshot of the message recommending you increase the heap size.](/assets/images/help/codespaces/heap-size-message.png) - -Depending on the size of your codebase, and the memory needed to run your application, you may need to increase the heap size further. You should set the heap size to somewhere between the size shown in the table above and 60% of the remote host's RAM. If you have a large application, you should not set too large a heap size, so that you allow the application adequate memory. - -1. On the left of the navigation bar, at the top of the application window, click the name of the codespace. - - ![Screenshot of the JetBrains client. The codespace name "urban meme," labeled "Resources critical," is highlighted with a dark orange outline.](/assets/images/help/codespaces/jetbrains-resources-button.png) - -1. In the Performance tab, note the CPU Load and Memory details. These will indicate whether the machine is overloaded. - - ![Screenshot of the "Performance" tab in the resources dropdown, showing CPU Load at 97.5%, Memory at 60.6%, and Disk at 28.8%.](/assets/images/help/codespaces/jetbrains-performance.png) - -1. Click the Settings tab and edit the heap size, increasing it to no more than 60% of the available memory for your codespace. - - ![Screenshot of the "Performance" tab. In the "Maximum heap size" field, 3072 is entered and outlined in dark orange. Below this are "Save" and "Save and restart" buttons.](/assets/images/help/codespaces/jetbrains-heap-setting.png) - -1. Click **Save and restart**. - -### Client can't be opened in macOS Ventura - -In macOS Ventura, using versions of the JetBrains Gateway prior to version 2022.3, the first time you try to connect to a codespace from the JetBrains Gateway a message was displayed telling you that the JetBrains client application "is damaged and can't be opened." - -Screenshot of the 'cannot be opened' error message - -This issue is fixed in the JetBrains Gateway, version 2022.3 and later. - -To avoid this issue, update the JetBrains Gateway. - -To work around this problem with older versions of the Gateway: - -1. Click **Cancel** to dismiss this message. -1. Click the Apple icon, top left of the screen, and click **System Settings**. -1. Click **Privacy & Security** and scroll down to the "Security" section. - - ![Screenshot of macOS "Privacy & Security" dialog, with a security message above the JetBrains Client and the "Open Anyway" button.](/assets/images/help/codespaces/jetbrains-privacy-and-security.png) - - You will see a message telling you that the JetBrains Client was blocked from use. - -1. Click **Open Anyway** to add the JetBrains client to your recognized applications. - The message is displayed again but this time with an **Open** button. - - Screenshot of the error message with an 'Open' button - -1. Click **Cancel** again. -1. Go back to the JetBrains Gateway application and connect to the required codespace again. - The JetBrains client will now open successfully. Having authorized the client application to run on your Mac, you will not see the message when you connect to your codespaces in future. - -### SSH connection issues - -To connect via the SSH server running in your codespace, you must have an SSH key in your `~/.ssh` directory (macOS and Linux) or `%HOMEPATH%\.ssh` directory (Windows) that has already been added to your {% data variables.product.prodname_dotcom %} account. If you do not have any keys in this directory, {% data variables.product.prodname_cli %} will generate keys for you. For more information, see [AUTOTITLE](/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account?platform=windows&tool=webui). - -If you encounter problems with key validation, try upgrading your version of {% data variables.product.prodname_cli %}. For information, see the [upgrade instructions](https://github.com/cli/cli#installation) in the README for {% data variables.product.prodname_cli %}. - -### JetBrains IDE issues - -For help with issues specific to the JetBrains IDE you are using, or the JetBrains Gateway application, see [Product Support](https://www.jetbrains.com/support/) on the JetBrains website. - -{% endjetbrains_beta %} diff --git a/data/reusables/codespaces/application-installed-locally.md b/data/reusables/codespaces/application-installed-locally.md index 69042ce72204..2466e8de32d2 100644 --- a/data/reusables/codespaces/application-installed-locally.md +++ b/data/reusables/codespaces/application-installed-locally.md @@ -1 +1 @@ -If you choose **{% data variables.product.prodname_vscode %}** or **JetBrains Gateway**, you must make sure you have installed the selected application on your local machine. +If you choose **{% data variables.product.prodname_vscode %}**, you must make sure you have installed the selected application on your local machine. diff --git a/data/reusables/codespaces/codespaces-jetbrains-beta-note.md b/data/reusables/codespaces/codespaces-jetbrains-beta-note.md deleted file mode 100644 index 9a8e6675cbfb..000000000000 --- a/data/reusables/codespaces/codespaces-jetbrains-beta-note.md +++ /dev/null @@ -1,3 +0,0 @@ -> [!NOTE] -> * Using {% data variables.product.prodname_github_codespaces %} with JetBrains IDEs is currently in {% data variables.release-phases.public_preview %} and is subject to change. -> * To work on a codespace in a JetBrains IDE you must use release 2023.3.\* or 2024.1.\* of the JetBrains Gateway. diff --git a/data/reusables/codespaces/jetbrains-open-codespace-plugin.md b/data/reusables/codespaces/jetbrains-open-codespace-plugin.md deleted file mode 100644 index 8229bfff6369..000000000000 --- a/data/reusables/codespaces/jetbrains-open-codespace-plugin.md +++ /dev/null @@ -1,3 +0,0 @@ -1. In the JetBrains client, click the {% data variables.product.prodname_github_codespaces %} plugin to display the {% data variables.product.prodname_github_codespaces %} tool window. - - ![Screenshot of the {% data variables.product.prodname_github_codespaces %} tool window. The "{% data variables.product.prodname_github_codespaces %}" tool window selector is highlighted with an orange outline.](/assets/images/help/codespaces/jetbrains-codespaces-tool-window.png) diff --git a/data/reusables/codespaces/linking-to-an-existing-codespace.md b/data/reusables/codespaces/linking-to-an-existing-codespace.md index 1029be005808..09376464adad 100644 --- a/data/reusables/codespaces/linking-to-an-existing-codespace.md +++ b/data/reusables/codespaces/linking-to-an-existing-codespace.md @@ -12,5 +12,4 @@ Create a link using one of the following URL patterns. In these URLs `CODESPACE- | {% data variables.product.prodname_vscode_shortname %} web client | `https://CODESPACE-NAME.github.dev` | | {% data variables.product.prodname_vscode_shortname %} web client with a specified workspace | `https://CODESPACE-NAME.github.dev?folder=/workspaces/PATH/TO/WORKSPACE/DIRECTORY` | | {% data variables.product.prodname_vscode_shortname %} desktop application | `https://github.com/codespaces/CODESPACE-NAME?editor=vscode` | -| JetBrains Gateway | `https://github.com/codespaces/CODESPACE-NAME?editor=jetbrains` | | JupyterLab | `https://github.com/codespaces/CODESPACE-NAME?editor=jupyter` | diff --git a/data/reusables/codespaces/opening-codespace-in-jetbrains.md b/data/reusables/codespaces/opening-codespace-in-jetbrains.md deleted file mode 100644 index 9f42bbd932e7..000000000000 --- a/data/reusables/codespaces/opening-codespace-in-jetbrains.md +++ /dev/null @@ -1,27 +0,0 @@ -If you have set the JetBrains Gateway as your default editor, then the Gateway will launch automatically when you open a codespace from {% data variables.product.github %}. - -If the JetBrains Gateway is not your default editor, you can still open a codespace in JetBrains by going to the "Your codespaces" page at [github.com/codespaces](https://github.com/codespaces) and clicking the ellipsis (...) to the right of the codespace you want to open. For more information, see [AUTOTITLE](/codespaces/developing-in-codespaces/opening-an-existing-codespace?tool=webui). - -Alternatively, you can also open the JetBrains Gateway and select an existing codespace, as described in the following procedure. - -1. Open the JetBrains Gateway application. -1. Click **Connect to {% data variables.product.prodname_codespaces %}**. - - ![Screenshot of the JetBrains Gateway home page, showing the "Connect to Codespaces" button.](/assets/images/help/codespaces/jetbrains-gateway-connect.png) - -1. In the "Your Codespaces" list, click the codespace you want to work in. - - ![Screenshot of the "Your Codespaces" list in the JetBrains Gateway.](/assets/images/help/codespaces/jetbrains-gateway-codespaces.png) - -1. In the "Available IDEs" list, click the JetBrains IDE you want to use. The Gateway will remember your choice the next time you connect to a codespace. - - ![Screenshot the "Select IDE" dropdown list in the JetBrains Gateway. The mouse pointer is pointing to "IntelliJ IDEA."](/assets/images/help/codespaces/jetbrains-gateway-ides.png) - -1. Click **Connect**. - - > [!NOTE] - > * If you chose Rider as your JetBrains IDE and the repository contains multiple solution files, the "Set Solution Path" dialog is displayed prompting you to choose which solution you want to work in. Choose a solution file from the dropdown menu and click **OK**. - > - > If the repository doesn't have a solution file, Rider opens in a basic project directory view and will have limited capabilities. For instance, you won't get .NET-specific code navigation. If there is just a single solution file in the repository it will be used automatically, without the prompt being displayed. For more information, see [Create and open projects and solutions](https://www.jetbrains.com/help/rider/Creating_and_Opening_Projects_and_Solutions.html) in the JetBrains documentation.

- > - > * If you are running a firewall, then the first time you connect to a remote resource you may be prompted to allow the JetBrains Gateway to communicate across your network. diff --git a/data/reusables/codespaces/port-forwarding-adding-non-jetbrains.md b/data/reusables/codespaces/port-forwarding-adding.md similarity index 100% rename from data/reusables/codespaces/port-forwarding-adding-non-jetbrains.md rename to data/reusables/codespaces/port-forwarding-adding.md diff --git a/data/reusables/codespaces/port-forwarding-intro-non-jetbrains.md b/data/reusables/codespaces/port-forwarding-intro.md similarity index 100% rename from data/reusables/codespaces/port-forwarding-intro-non-jetbrains.md rename to data/reusables/codespaces/port-forwarding-intro.md diff --git a/data/reusables/codespaces/port-forwarding-labeling-non-jetbrains.md b/data/reusables/codespaces/port-forwarding-labeling.md similarity index 100% rename from data/reusables/codespaces/port-forwarding-labeling-non-jetbrains.md rename to data/reusables/codespaces/port-forwarding-labeling.md diff --git a/data/reusables/codespaces/port-forwarding-sharing-non-jetbrains.md b/data/reusables/codespaces/port-forwarding-sharing.md similarity index 100% rename from data/reusables/codespaces/port-forwarding-sharing-non-jetbrains.md rename to data/reusables/codespaces/port-forwarding-sharing.md diff --git a/data/reusables/codespaces/rebuilding-container-procedures.md b/data/reusables/codespaces/rebuilding-container-procedures.md index 4064e16d3496..d96b9ea17390 100644 --- a/data/reusables/codespaces/rebuilding-container-procedures.md +++ b/data/reusables/codespaces/rebuilding-container-procedures.md @@ -8,7 +8,7 @@ ### Using {% data variables.product.prodname_cli %} to rebuild a dev container -If you've changed a dev container configuration outside of {% data variables.product.prodname_vscode_shortname %} (for example, on {% data variables.product.github %} or in a JetBrains IDE), you can use {% data variables.product.prodname_cli %} to rebuild the dev container for an existing codespace. +If you've changed a dev container configuration outside of {% data variables.product.prodname_vscode_shortname %} (for example, on {% data variables.product.github %}), you can use {% data variables.product.prodname_cli %} to rebuild the dev container for an existing codespace. 1. In a terminal, enter the following command. From 14c1272aad40e17d8e2db96f5539d6021bcf06e7 Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Mon, 6 Jan 2025 03:43:40 -0800 Subject: [PATCH 15/17] Update audit log event data (#53734) Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> --- src/audit-logs/lib/config.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/audit-logs/lib/config.json b/src/audit-logs/lib/config.json index 290606d8031f..c58ab834cd17 100644 --- a/src/audit-logs/lib/config.json +++ b/src/audit-logs/lib/config.json @@ -3,5 +3,5 @@ "apiOnlyEvents": "This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.", "apiRequestEvent": "This event is only available via audit log streaming." }, - "sha": "aed021929f55efd8e1f773834dff3f02e75d1eba" + "sha": "f35047bbdf790cfb45ee2be4eb74ee966b7f3d52" } \ No newline at end of file From 4fe5ba706547a79dcf58e228525d70ee34f70875 Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Mon, 6 Jan 2025 03:59:38 -0800 Subject: [PATCH 16/17] Delete orphaned features (2024-12-30-16-28) (#53739) Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> --- data/features/default-setup-pre-enablement-ghes.yml | 7 ------- 1 file changed, 7 deletions(-) delete mode 100644 data/features/default-setup-pre-enablement-ghes.yml diff --git a/data/features/default-setup-pre-enablement-ghes.yml b/data/features/default-setup-pre-enablement-ghes.yml deleted file mode 100644 index ce0b2a3e3b11..000000000000 --- a/data/features/default-setup-pre-enablement-ghes.yml +++ /dev/null @@ -1,7 +0,0 @@ -# Default setup for code scanning can now be enabled on any repository, including repositories that don't contain a -# CodeQL-supported language, and scans will begin automatically if/when a CodeQL-supported language is added. This -# versioning pairs with `default-setup-pre-enablement` and was created to future-proof GHES-specific sections. -# Reference: #12363 - -versions: - ghes: '>3.12' From 325c1308707fc9759144d0365fa39ed7338fcea9 Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Mon, 6 Jan 2025 04:16:24 -0800 Subject: [PATCH 17/17] Update audit log event data (#53740) Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> --- src/audit-logs/lib/config.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/audit-logs/lib/config.json b/src/audit-logs/lib/config.json index c58ab834cd17..39421fd41e1a 100644 --- a/src/audit-logs/lib/config.json +++ b/src/audit-logs/lib/config.json @@ -3,5 +3,5 @@ "apiOnlyEvents": "This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.", "apiRequestEvent": "This event is only available via audit log streaming." }, - "sha": "f35047bbdf790cfb45ee2be4eb74ee966b7f3d52" + "sha": "eafe424495cc22bd92b9122b9bb41a01f07314d9" } \ No newline at end of file