Update variables usage for Proxima in Tools and Automations docs (#52219)
Co-authored-by: Isaac Brown <101839405+isaacmbrown@users.noreply.github.com>
This commit is contained in:
Joe Clark
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Renaming a codespace
|
||||
intro: 'You can change the codespace display name to one of your choice through {% data variables.product.prodname_dotcom_the_website %} or the {% data variables.product.prodname_cli %}.'
|
||||
intro: 'You can change the codespace display name to one of your choice on {% data variables.product.github %} or using the {% data variables.product.prodname_cli %}.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
@@ -59,7 +59,7 @@ For more information, see "[AUTOTITLE](/codespaces/developing-in-a-codespace/usi
|
||||
|
||||
{% webui %}
|
||||
|
||||
You can change the display name for your codespace on {% data variables.product.prodname_dotcom_the_website %}.
|
||||
You can change the display name for your codespace on {% data variables.product.github %}.
|
||||
|
||||
{% data reusables.codespaces.your-codespaces-procedure-step %}
|
||||
|
||||
|
||||
@@ -21,7 +21,7 @@ shortTitle: Create a codespace for a repo
|
||||
|
||||
{% data reusables.codespaces.ways-to-create-a-codespace %} Use the tabs in this article to display instructions for each of these ways of creating a codespace.
|
||||
|
||||
You can use {% data variables.product.prodname_github_codespaces %} on your personal {% data variables.product.prodname_dotcom_the_website %} account, with the quota of free use included each month for accounts on the Free and Pro plans. {% data reusables.codespaces.codespaces-continue-by-paying %}
|
||||
You can use {% data variables.product.prodname_github_codespaces %} on your personal {% data variables.product.github %} account, with the quota of free use included each month for accounts on the Free and Pro plans. {% data reusables.codespaces.codespaces-continue-by-paying %}
|
||||
|
||||
Organizations can enable members and outside collaborators to create and use codespaces at the organization's expense. For more information, see "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/choosing-who-owns-and-pays-for-codespaces-in-your-organization)."
|
||||
|
||||
|
||||
@@ -85,9 +85,9 @@ When a codespace is published, you have access to a greater range of options to
|
||||
* Allow {% data variables.product.prodname_dotcom %} to automatically use GPG to sign commits you make in your codespace (see "[AUTOTITLE](/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces)").
|
||||
* Share secrets with your codespace (see "[AUTOTITLE](/codespaces/managing-your-codespaces/managing-your-account-specific-secrets-for-github-codespaces)").
|
||||
|
||||
### Publishing from {% data variables.product.prodname_dotcom_the_website %}
|
||||
### Publishing from {% data variables.product.github %}
|
||||
|
||||
You can publish an unpublished codespace from the "Your codespaces" page on {% data variables.product.prodname_dotcom_the_website %}. This is useful if you want to publish a codespace that you don't currently have open in your browser. If you do this, your work will be preserved in a repository, but there won't be a link between your existing codespace and the new repository. However, you can navigate to the new repository and create a codespace from there, and this codespace will be connected to the repository.
|
||||
You can publish an unpublished codespace from the "Your codespaces" page on {% data variables.product.github %}. This is useful if you want to publish a codespace that you don't currently have open in your browser. If you do this, your work will be preserved in a repository, but there won't be a link between your existing codespace and the new repository. However, you can navigate to the new repository and create a codespace from there, and this codespace will be connected to the repository.
|
||||
|
||||
{% data reusables.codespaces.your-codespaces-procedure-step %}
|
||||
1. Next to the unpublished codespace, click the ellipsis (**...**), then select **Publish to a new repository**.
|
||||
|
||||
@@ -20,7 +20,7 @@ redirect_from:
|
||||
|
||||
{% endjetbrains_beta %}
|
||||
|
||||
You can reopen any of your active or stopped codespaces on {% data variables.product.prodname_dotcom_the_website %}, 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. For more information, 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 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. For more information, 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:
|
||||
|
||||
@@ -34,9 +34,9 @@ You can view all your codespaces on the "Your codespaces" page at [github.com/co
|
||||
|
||||
## Resuming a codespace from a repository page
|
||||
|
||||
You can quickly resume a codespace when you're viewing a repository on {% data variables.product.prodname_dotcom_the_website %}.
|
||||
You can quickly resume a codespace when you're viewing a repository on {% data variables.product.github %}.
|
||||
|
||||
1. With the {% octicon "code" aria-hidden="true" %} **Code** tab of your repository displayed on {% data variables.product.prodname_dotcom_the_website %}, press <kbd>,</kbd> (the comma key).
|
||||
1. With the {% octicon "code" aria-hidden="true" %} **Code** tab of your repository displayed on {% data variables.product.github %}, press <kbd>,</kbd> (the comma key).
|
||||
|
||||
The "Resume codespace" page is displayed. This allows you to resume your most recently used codespace for the currently selected branch of the repository or, if you were viewing a pull request, for the topic branch of the pull request.
|
||||
|
||||
|
||||
@@ -21,7 +21,7 @@ Using a codespace to work on a pull request gives you all the benefits of {% dat
|
||||
|
||||
{% data variables.product.prodname_github_codespaces %} provides you with many of the capabilities you might need to work with pull requests:
|
||||
|
||||
* [Create a pull request](/codespaces/developing-in-a-codespace/using-source-control-in-your-codespace#raising-a-pull-request) - Using either the Terminal and Git commands or the "Source Control" view, you can create pull requests just as you would on {% data variables.product.prodname_dotcom_the_website %}. If the repository uses a pull request template, you'll be able to use this within the "Source Control" view.
|
||||
* [Create a pull request](/codespaces/developing-in-a-codespace/using-source-control-in-your-codespace#raising-a-pull-request) - Using either the Terminal and Git commands or the "Source Control" view, you can create pull requests just as you would on {% data variables.product.github %}. If the repository uses a pull request template, you'll be able to use this within the "Source Control" view.
|
||||
* [Open a pull request](#opening-a-pull-request-in-codespaces) – You can open an existing pull request in a codespace, provided you have codespace access to the branch that is being merged in.
|
||||
* [Review a pull request](#reviewing-a-pull-request-in-codespaces) - Once you have opened a pull request in a codespace, you can use the "GitHub Pull Request" view to add review comments and approve pull requests. You can also use {% data variables.product.prodname_github_codespaces %} to [view review comments](#view-comments-from-a-review-in-codespaces).
|
||||
|
||||
|
||||
@@ -22,7 +22,7 @@ topics:
|
||||
|
||||
You can use your local install of {% data variables.product.prodname_vscode %} to create, manage, work in, and delete codespaces. {% data reusables.codespaces.using-codespaces-in-vscode %} For more information on setting up {% data variables.product.prodname_github_codespaces %} in {% data variables.product.prodname_vscode_shortname %}, see "[Prerequisites](#prerequisites)."
|
||||
|
||||
By default, if you create a new codespace on {% data variables.product.prodname_dotcom_the_website %}, it will open in the browser. If you would prefer to open any new codespaces in {% data variables.product.prodname_vscode_shortname %} automatically, you can set your default editor to be {% data variables.product.prodname_vscode_shortname %}. For more information, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/setting-your-default-editor-for-github-codespaces)."
|
||||
By default, if you create a new codespace on {% data variables.product.github %}, it will open in the browser. If you would prefer to open any new codespaces in {% data variables.product.prodname_vscode_shortname %} automatically, you can set your default editor to be {% data variables.product.prodname_vscode_shortname %}. For more information, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/setting-your-default-editor-for-github-codespaces)."
|
||||
|
||||
If you prefer to work in the browser, but want to continue using your existing {% data variables.product.prodname_vscode_shortname %} extensions, themes, and shortcuts, you can turn on Settings Sync. For more information, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account#settings-sync)."
|
||||
|
||||
|
||||
@@ -19,13 +19,13 @@ redirect_from:
|
||||
|
||||
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.prodname_dotcom_the_website %}, the JetBrains Gateway will launch to allow you to choose your JetBrains IDE and connect to the codespace.
|
||||
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 %}
|
||||
|
||||
**Note:** Only existing codespaces are available in the JetBrains Gateway. You can create codespaces in {% data variables.product.prodname_dotcom_the_website %}, or by using {% data variables.product.prodname_cli %}. For more information, see "[AUTOTITLE](/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository)."
|
||||
**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)."
|
||||
|
||||
{% endnote %}
|
||||
|
||||
@@ -81,7 +81,7 @@ For more information about the `devcontainer.json` file and the default containe
|
||||
|
||||
## 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.prodname_dotcom_the_website %} using your {% data variables.product.prodname_dotcom %} account.
|
||||
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**.
|
||||
|
||||
@@ -17,7 +17,7 @@ topics:
|
||||
|
||||
There are a number of entry points to create a codespace.
|
||||
|
||||
* From a {% data variables.product.company_short %} template or any template repository on {% data variables.product.prodname_dotcom_the_website %} to start a new project
|
||||
* From a {% data variables.product.company_short %} template or any template repository on {% data variables.product.github %} to start a new project
|
||||
* From a branch in your repository for new feature work
|
||||
* From an open pull request to explore work-in-progress
|
||||
* From a commit in a repository's history to investigate a bug at a specific point in time
|
||||
|
||||
@@ -76,7 +76,7 @@ Now that you've made a few changes, you can use the integrated terminal or the s
|
||||
|
||||
|
||||
The owner of the new repository will be the {% data variables.product.prodname_dotcom %} account with which you created the codespace.
|
||||
1. In the pop-up that appears in the lower right corner of the editor, click **Open on {% data variables.product.prodname_dotcom %}** to view the new repository on {% data variables.product.prodname_dotcom_the_website %}. In the new repository, view the `haikus.json` file and check that the change you made in your codespace has been successfully pushed to the repository.
|
||||
1. In the pop-up that appears in the lower right corner of the editor, click **Open on {% data variables.product.prodname_dotcom %}** to view the new repository on {% data variables.product.github %}. In the new repository, view the `haikus.json` file and check that the change you made in your codespace has been successfully pushed to the repository.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -30,7 +30,7 @@ If you don't specify an image in the dev container configuration for a repositor
|
||||
|
||||
As an organization owner, you can add a policy to restrict which dev container images can be used for codespaces created within your organization.
|
||||
|
||||
If you attempt to create a codespace using a `devcontainer.json` that specifies an image that is not allowed by the policy, the following message is displayed in {% data variables.product.prodname_dotcom_the_website %}:
|
||||
If you attempt to create a codespace using a `devcontainer.json` that specifies an image that is not allowed by the policy, the following message is displayed in {% data variables.product.github %}:
|
||||
|
||||
> The codespace cannot be created because the image specified in your dev container configuration is not allowed. You may need to select a different branch, modify your container configuration, or adjust your organization's policy setting.
|
||||
|
||||
|
||||
@@ -50,7 +50,7 @@ To begin developing using cloud-based compute resources, you can create a codesp
|
||||
|
||||
### Using codespaces owned by your personal account
|
||||
|
||||
All personal {% data variables.product.prodname_dotcom_the_website %} accounts have a monthly quota of free use of {% data variables.product.prodname_github_codespaces %} included in the Free or Pro plan. You can get started using {% data variables.product.prodname_github_codespaces %} on your personal account without changing any settings or providing payment details.
|
||||
All personal {% data variables.product.github %} accounts have a monthly quota of free use of {% data variables.product.prodname_github_codespaces %} included in the Free or Pro plan. You can get started using {% data variables.product.prodname_github_codespaces %} on your personal account without changing any settings or providing payment details.
|
||||
|
||||
If you create a codespace from an organization-owned repository, use of the codespace will either be charged to the organization (if the organization is configured for this), or to your personal account.
|
||||
|
||||
|
||||
@@ -39,7 +39,7 @@ To see the log output for the latest prebuild workflow run, click **See output**
|
||||
|
||||
This displays the output of the most recent run of the workflow in the **Actions** tab.
|
||||
|
||||
|
||||
|
||||
|
||||
Alternatively, to view all prebuild workflow runs associated with the specified branch, select the {% octicon "kebab-horizontal" aria-label="options" %} dropdown menu and click **View runs**.
|
||||
|
||||
|
||||
@@ -38,7 +38,7 @@ You can check the current service status on the [Status Dashboard](https://www.g
|
||||
|
||||
## Option 3: Clone the repository locally or edit in the browser
|
||||
|
||||
While {% data variables.product.prodname_github_codespaces %} provides the benefit of a pre-configured developer environment, your source code should always be accessible through the repository hosted on {% data variables.product.prodname_dotcom_the_website %}. In the event of a {% data variables.product.prodname_github_codespaces %} outage, you can still clone the repository locally or edit files in the {% data variables.product.company_short %} browser editor. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-files/editing-files)."
|
||||
While {% data variables.product.prodname_github_codespaces %} provides the benefit of a pre-configured developer environment, your source code should always be accessible through the repository hosted on {% data variables.product.github %}. In the event of a {% data variables.product.prodname_github_codespaces %} outage, you can still clone the repository locally or edit files in the {% data variables.product.company_short %} browser editor. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-files/editing-files)."
|
||||
|
||||
While this option does not configure a development environment for you, it will allow you to make changes to your source code as needed while you wait for the service disruption to resolve.
|
||||
|
||||
|
||||
@@ -188,7 +188,7 @@ If none of the predefined configurations meets your needs, you can create a cust
|
||||
|
||||
### Adding a `devcontainer.json` file
|
||||
|
||||
If you don't already have a `devcontainer.json` file in your repository, you can quickly add one from {% data variables.product.prodname_dotcom_the_website %}.
|
||||
If you don't already have a `devcontainer.json` file in your repository, you can quickly add one from {% data variables.product.github %}.
|
||||
1. Navigate to your repository and click the **{% octicon "code" aria-hidden="true" %} Code** dropdown.
|
||||
1. In the **Codespaces** tab, click the ellipsis (**...**), then select **Configure dev container**.
|
||||
|
||||
|
||||
@@ -20,7 +20,7 @@ redirect_from:
|
||||
|
||||
{% webui %}
|
||||
|
||||
1. Navigate to your repository on {% data variables.product.prodname_dotcom_the_website %}, find your `devcontainer.json` file, and click {% octicon "pencil" aria-label="Edit this file" %} to edit the file.
|
||||
1. Navigate to your repository on {% data variables.product.github %}, find your `devcontainer.json` file, and click {% octicon "pencil" aria-label="Edit this file" %} to edit the file.
|
||||
|
||||
If you don't already have a `devcontainer.json` file, you can create one now. For more information, see "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers#creating-a-custom-dev-container-configuration)."
|
||||
1. To the right of the file editor, in the **Marketplace** tab, browse or search for the feature you want to add, then click the name of the feature.
|
||||
|
||||
@@ -16,7 +16,7 @@ topics:
|
||||
|
||||
If a project needs user-specific secrets to be set up, you can prompt people to do this when they create a codespace. You do this by adding a setting to a dev container configuration file for the repository.
|
||||
|
||||
After you specify recommended secrets, if people have not already created those secrets in their personal settings for {% data variables.product.prodname_codespaces %}, they will be prompted to do so when they use the advanced options method of creating a codespace. This is done on {% data variables.product.prodname_dotcom_the_website %} by clicking the **{% octicon "code" aria-hidden="true" %} Code** button, then clicking the **Codespaces** tab, then selecting {% octicon "kebab-horizontal" aria-label="Codespace repository configuration" %} and clicking **New with options**.
|
||||
After you specify recommended secrets, if people have not already created those secrets in their personal settings for {% data variables.product.prodname_codespaces %}, they will be prompted to do so when they use the advanced options method of creating a codespace. This is done on {% data variables.product.github %} by clicking the **{% octicon "code" aria-hidden="true" %} Code** button, then clicking the **Codespaces** tab, then selecting {% octicon "kebab-horizontal" aria-label="Codespace repository configuration" %} and clicking **New with options**.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -114,7 +114,7 @@ If you don't specify a retention period when you create a codespace, then either
|
||||
|
||||
## Setting the retention period
|
||||
|
||||
You can set your default retention period in your web browser, on {% data variables.product.prodname_dotcom_the_website %}. Alternatively, if you use {% data variables.product.prodname_cli %} to create a codespace you can set a retention period for that particular codespace. For more information, click the appropriate tab above.
|
||||
You can set your default retention period in your web browser, on {% data variables.product.github %}. Alternatively, if you use {% data variables.product.prodname_cli %} to create a codespace you can set a retention period for that particular codespace. For more information, click the appropriate tab above.
|
||||
|
||||
## Checking whether codespaces will be autodeleted soon
|
||||
|
||||
|
||||
@@ -63,7 +63,7 @@ If you don't specify a timeout period when you create a codespace, then the defa
|
||||
|
||||
## Setting a timeout period
|
||||
|
||||
You can set your default timeout period in your web browser, on {% data variables.product.prodname_dotcom_the_website %}. Alternatively, if you use {% data variables.product.prodname_cli %} to create a codespace you can set a timeout period for that particular codespace. For more information, click the appropriate tab above.
|
||||
You can set your default timeout period in your web browser, on {% data variables.product.github %}. Alternatively, if you use {% data variables.product.prodname_cli %} to create a codespace you can set a timeout period for that particular codespace. For more information, click the appropriate tab above.
|
||||
|
||||
{% endvscode %}
|
||||
|
||||
|
||||
@@ -29,7 +29,7 @@ The {% data variables.codespaces.serverless %} editor provides many of the benef
|
||||
|
||||
The {% data variables.codespaces.serverless %} editor runs entirely in your browser’s sandbox. The editor doesn’t clone the repository, but instead uses the [GitHub Repositories extension](https://code.visualstudio.com/docs/editor/github#_github-repositories-extension) to carry out most of the functionality that you will use. Your work is saved in the browser’s local storage until you commit it. You should commit your changes regularly to ensure that they're always accessible.
|
||||
|
||||
You must be signed in to {% data variables.product.prodname_dotcom_the_website %} to use the {% data variables.codespaces.serverless %} editor.
|
||||
You must be signed in to {% data variables.product.github %} to use the {% data variables.codespaces.serverless %} editor.
|
||||
|
||||
## Opening the {% data variables.codespaces.serverless %} editor
|
||||
|
||||
|
||||
@@ -97,7 +97,7 @@ If the dev container for the current codespace was built from the default image,
|
||||
du -h -s ~/.vscode-remote/extensions
|
||||
```
|
||||
|
||||
* Monitor your compute and storage usage by going to your billing page on {% data variables.product.prodname_dotcom_the_website %}, https://github.com/settings/billing, and reviewing the figures in the "{% data variables.product.prodname_codespaces %}" section.
|
||||
* Monitor your compute and storage usage by going to your billing page on {% data variables.product.github %}, https://github.com/settings/billing, and reviewing the figures in the "{% data variables.product.prodname_codespaces %}" section.
|
||||
{% note %}
|
||||
|
||||
**Note**: Storage is calculated hourly and added to your existing storage usage. Consumed storage is therefore cumulative for the duration of your month-long billing cycle. This means that, during the billing period, the value you see on your billing page will only increase or remain the same. Usage will be reset to zero when a new billing cycle starts. Deleting a codespace, or a prebuild, will not reduce the usage figure for the current month, but it will reduce the rate at which storage usage accumulates.
|
||||
|
||||
Reference in New Issue
Block a user