* Draft - add copy from Google doc * Add images * More WiP * test (#25121) * Update actions-scheduled-workflow-example.md The editor when changing a CRON time says the most frequent is 5 minutes. Either this section is incorrect or the editor pop over.. * Fix "labels" type * Add apps permissions for code scanning org endpoint. (#24859) * cope with possible translation drift (#24842) * cope with possible translation drift * fix test * don't shallow clone * fix unit tests * update code comments * more code comment corrections * more code comment * feedbacked * Add 💅 * Remove yzhang.markdown-all-in-one extension The markdown-all-in-one extension prevents Alfred expansions happening correctly. * Revert Add apps permissions for code scanning org endpoint (#25023) * Add security overview to github-security-features.md * updating ghcr_token github_token * archived asset redirects (#25025) * updating ghec_token to github_token * set 'manul-purge' surrogate key on assets/cb- URLs (#25028) * Member privileges edit for forking help doc (#24934) * calm down Backfill logging (#25031) * [Feb. 2, 2022] Updates for settings nav redesign (#24604) * Replace accessibility-tab.png with octicon * Update and version appearance-tab references * Replace codespaces-tab.png with octicon * Replace product name with reusable * Version reusable using developer-settings.png * Version reusable using notifcations_menu.png * Replace org-settings-pages.png with octicon * Version reusable using repos-tab.png * Version reusable using saved-replies-tab.png * Version reusable with settings-applications.png * Version reusable with settings-sidebar-account-security.png * version reusable with settings-sidebar-account-settings.png * Replace settings-sidebar-billing-plans.png with octicon * Replace settings-sidebar-blocked-users.png with octicon * Version settings-sidebar-deploy-keys.png * Version reusable with settings-sidebar-emails.png * Replace settings-sidebar-interaction-limits.png with octicon * Replace settings-sidebar-organizations.png with octicon * Version use of settings-sidebar-repositories.png * Version reusable with settings-seidebar-security-analysis.png * Version reusable with settings-sidebar-ssh-keys.png * Version reusable with settings-sidebar-team-settings.png * Replace settings-sidebar-third-party-access.png with octicon * Version reusable with settings-user-orgs.png * Replace user-settings-pages.png with octicon * Update pages octicon * Add explicit versions to elsif tags * Rewording for consistency * Improve versioning for future GHAE * Add missing space Co-authored-by: Felicity Chapman <felicitymay@github.com> Co-authored-by: Felicity Chapman <felicitymay@github.com> * update search indexes * New translation batch for es (#25035) * Add crowdin translations * Run script/i18n/homogenize-frontmatter.js * Run script/i18n/fix-translation-errors.js * Run script/i18n/lint-translation-files.js --check parsing * run script/i18n/reset-files-with-broken-liquid-tags.js --language=es * run script/i18n/reset-known-broken-translation-files.js * Check in es CSV report * Remove duplicated word (#24974) * Fix when we show the 'All Enterprise Releases' link (#25002) * Enterprise versions start with 'enterprise-server' * Show only if all versions are ghes versions * Show link if there's any ghes versioning * Depend on the path for the tool switcher (#25018) * Azure: use shared env setter, fix comment workflow (#25044) * update azure deployments to use shared env getter, fix content changes table * update search indexes * update search indexes * Update workflow-syntax-for-github-actions.md * New translation batch for pt (#25050) * Add crowdin translations * Run script/i18n/homogenize-frontmatter.js * Run script/i18n/fix-translation-errors.js * Run script/i18n/lint-translation-files.js --check parsing * run script/i18n/reset-files-with-broken-liquid-tags.js --language=pt * run script/i18n/reset-known-broken-translation-files.js * update search indexes * The missing full stop was added. * update search indexes * update search indexes * New translation batch for pt (#25057) * Add crowdin translations * Run script/i18n/homogenize-frontmatter.js * Run script/i18n/fix-translation-errors.js * Run script/i18n/lint-translation-files.js --check parsing * run script/i18n/reset-files-with-broken-liquid-tags.js --language=pt * run script/i18n/reset-known-broken-translation-files.js * New translation batch for es (#25058) * Add crowdin translations * Run script/i18n/homogenize-frontmatter.js * Run script/i18n/fix-translation-errors.js * Run script/i18n/lint-translation-files.js --check parsing * run script/i18n/reset-files-with-broken-liquid-tags.js --language=es * run script/i18n/reset-known-broken-translation-files.js * update search indexes * update search indexes * Update OpenAPI Descriptions (#25047) * update search indexes * Enterprise bug fixes: week of Jan 31, 2022 (#25043) * delete the workflow linter (#25075) * an empty 'product', 'permissions', or 'learningTracks' gets stuck (#25070) * and empty 'this.product' gets stuck * add test to prove change * Update OpenAPI Descriptions (#25071) * Update OpenAPI Descriptions (#25076) * Update OpenAPI Descriptions * Add decorated OpenAPI schema files Co-authored-by: github-openapi-bot <github-openapi-bot@users.noreply.github.com> * basic tests of the search API (#25069) * basic tests of the search API * lfs * Revert "Revert Add apps permissions for code scanning org endpoint (#25023)" (#25026) * update website-scraper to update transitive nth-check dep (#25080) * update search indexes * New translation batch for es (#25088) * Add crowdin translations * Run script/i18n/homogenize-frontmatter.js * Run script/i18n/fix-translation-errors.js * Run script/i18n/lint-translation-files.js --check parsing * run script/i18n/reset-files-with-broken-liquid-tags.js --language=es * run script/i18n/reset-known-broken-translation-files.js * Update code-scanning-alert.png (#25072) * use manual surrogate key for nextjs static assets (#25096) * use manual surrogate key for nextjs static assets * refactor * update search indexes * Update differences-between-clustering-and-high-availability-ha.md (#25107) * Update OpenAPI Descriptions (#25104) * Add versioning for GHAE 3.3 (#24936) * Update content/code-security/getting-started/github-security-features.md * update search indexes * [Actions] `push` event does not have Activity types (#15124) * 📝 Clarify usage of single quotes in string datatype for literals (#14895) * Fix value of GITHUB_REF for release events (#14876) * New translation batch for pt (#25084) * Add crowdin translations * Run script/i18n/homogenize-frontmatter.js * Run script/i18n/fix-translation-errors.js * Run script/i18n/lint-translation-files.js --check parsing * run script/i18n/reset-files-with-broken-liquid-tags.js --language=pt * run script/i18n/reset-known-broken-translation-files.js Co-authored-by: Mike Surowiec <mikesurowiec@users.noreply.github.com> * New translation batch for ja (#25093) * Add crowdin translations * Run script/i18n/homogenize-frontmatter.js * Run script/i18n/lint-translation-files.js --check parsing * run script/i18n/reset-files-with-broken-liquid-tags.js --language=ja * run script/i18n/reset-known-broken-translation-files.js * Check in ja CSV report Co-authored-by: Mike Surowiec <mikesurowiec@users.noreply.github.com> * New translation batch for cn (#25090) * Add crowdin translations * Run script/i18n/homogenize-frontmatter.js * Run script/i18n/lint-translation-files.js --check parsing * Run script/i18n/lint-translation-files.js --check rendering * run script/i18n/reset-files-with-broken-liquid-tags.js --language=cn * run script/i18n/reset-known-broken-translation-files.js * Check in cn CSV report Co-authored-by: Mike Surowiec <mikesurowiec@users.noreply.github.com> * Create github-debian.sh * Update Dockerfile * Update procedures for personal account recovery with two-factor authentication (#25040) * delete old deploy.js script (#24862) Co-authored-by: Mark Battistella <markbattistella@users.noreply.github.com> Co-authored-by: Emily Grace Seville <emilyseville7cf@gmail.com> Co-authored-by: Octomerger Bot <63058869+Octomerger@users.noreply.github.com> Co-authored-by: Anders Starcke Henriksen <starcke@github.com> Co-authored-by: Peter Bengtsson <mail@peterbe.com> Co-authored-by: Laura Coursen <lecoursen@github.com> Co-authored-by: lucie-docs <40564413+lucie-docs@users.noreply.github.com> Co-authored-by: Josh Johanning <joshjohanning@github.com> Co-authored-by: Tahlia G <84726379+tahlialouisa@users.noreply.github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Co-authored-by: Felicity Chapman <felicitymay@github.com> Co-authored-by: GitHub Actions <action@github.com> Co-authored-by: docubot <67483024+docubot@users.noreply.github.com> Co-authored-by: Simon Giesemann <kwacky1@github.com> Co-authored-by: Robert Sese <rsese@github.com> Co-authored-by: Mike Surowiec <mikesurowiec@users.noreply.github.com> Co-authored-by: Albin PK <56157868+albinpk@users.noreply.github.com> Co-authored-by: Dasun Tharanga <dasuntharangaflash@gmail.com> Co-authored-by: github-openapi-bot <69533958+github-openapi-bot@users.noreply.github.com> Co-authored-by: Ramya Parimi <33761166+ramyaparimi@users.noreply.github.com> Co-authored-by: github-openapi-bot <github-openapi-bot@users.noreply.github.com> Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com> Co-authored-by: Dorothy Mitchell <dorothymitchell@github.com> Co-authored-by: Andy J <mumfy@github.com> Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> Co-authored-by: Marko Kaznovac <kaznovac@users.noreply.github.com> Co-authored-by: Anil Seervi <61609033+AnilSeervi@users.noreply.github.com> Co-authored-by: Johanan Idicula <johanan@forcepush.tech> * Add more screenshots * complete items on plan * Revert changes to files I didn't change * Minor tweaks * Update content/codespaces/customizing-your-codespace/prebuilding-codespaces-for-your-project.md * Update content/codespaces/customizing-your-codespace/prebuilding-codespaces-for-your-project.md * Update content/codespaces/customizing-your-codespace/prebuilding-codespaces-for-your-project.md Co-authored-by: Jackie Jiménez <jaclynj@github.com> * Update content/codespaces/customizing-your-codespace/prebuilding-codespaces-for-your-project.md * Update content/codespaces/customizing-your-codespace/prebuilding-codespaces-for-your-project.md * Update content/codespaces/customizing-your-codespace/prebuilding-codespaces-for-your-project.md Co-authored-by: Jackie Jiménez <jaclynj@github.com> * Remove detail about building prebuilds by rerunning a workflow After deleting a prebuild configuration anyone who can access the workflow history can recreate the prebuilds by rerunning the previous workflow run - unless you go through manually deleting all of those entries from the workflow history. Removed this information as per review comment. * Update content/codespaces/customizing-your-codespace/prebuilding-codespaces-for-your-project.md Co-authored-by: Jackie Jiménez <jaclynj@github.com> * Update content/codespaces/customizing-your-codespace/prebuilding-codespaces-for-your-project.md * Update content/codespaces/customizing-your-codespace/prebuilding-codespaces-for-your-project.md * Update content/codespaces/customizing-your-codespace/prebuilding-codespaces-for-your-project.md Co-authored-by: Jackie Jiménez <jaclynj@github.com> * Update content/codespaces/customizing-your-codespace/prebuilding-codespaces-for-your-project.md * Update content/codespaces/customizing-your-codespace/prebuilding-codespaces-for-your-project.md * Update content/codespaces/customizing-your-codespace/prebuilding-codespaces-for-your-project.md * Update content/codespaces/customizing-your-codespace/prebuilding-codespaces-for-your-project.md Co-authored-by: Jackie Jiménez <jaclynj@github.com> * Update content/codespaces/customizing-your-codespace/prebuilding-codespaces-for-your-project.md * Update content/codespaces/customizing-your-codespace/prebuilding-codespaces-for-your-project.md Co-authored-by: Jackie Jiménez <jaclynj@github.com> * Update content/codespaces/customizing-your-codespace/prebuilding-codespaces-for-your-project.md * Update content/codespaces/customizing-your-codespace/prebuilding-codespaces-for-your-project.md * Update content/codespaces/customizing-your-codespace/prebuilding-codespaces-for-your-project.md * Update content/codespaces/customizing-your-codespace/prebuilding-codespaces-for-your-project.md Co-authored-by: Jackie Jiménez <jaclynj@github.com> * Update content/codespaces/customizing-your-codespace/prebuilding-codespaces-for-your-project.md * Update data/reusables/codespaces/billing-for-prebuilds.md * Update data/reusables/codespaces/billing-for-prebuilds.md * Restructure info into separate articles * Update content/codespaces/prebuilding-your-codespaces/about-codespaces-prebuilds.md Co-authored-by: Laura Coursen <lecoursen@github.com> * Move prerequisites section * Move billing info * Update content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md Co-authored-by: Laura Coursen <lecoursen@github.com> * Update content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md Co-authored-by: Laura Coursen <lecoursen@github.com> * Update content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md Co-authored-by: Laura Coursen <lecoursen@github.com> * Update content/codespaces/prebuilding-your-codespaces/managing-prebuilds.md Co-authored-by: Laura Coursen <lecoursen@github.com> * Update content/codespaces/prebuilding-your-codespaces/managing-prebuilds.md Co-authored-by: Laura Coursen <lecoursen@github.com> * Update content/codespaces/prebuilding-your-codespaces/managing-prebuilds.md Co-authored-by: Laura Coursen <lecoursen@github.com> * Update content/codespaces/prebuilding-your-codespaces/managing-prebuilds.md Co-authored-by: Laura Coursen <lecoursen@github.com> * Update content/codespaces/prebuilding-your-codespaces/managing-prebuilds.md Co-authored-by: Laura Coursen <lecoursen@github.com> * Update content/codespaces/prebuilding-your-codespaces/managing-prebuilds.md Co-authored-by: Laura Coursen <lecoursen@github.com> * Update content/codespaces/prebuilding-your-codespaces/managing-prebuilds.md Co-authored-by: Laura Coursen <lecoursen@github.com> * Update content/codespaces/prebuilding-your-codespaces/managing-prebuilds.md Co-authored-by: Laura Coursen <lecoursen@github.com> * Update content/codespaces/prebuilding-your-codespaces/managing-prebuilds.md Co-authored-by: Laura Coursen <lecoursen@github.com> * Update content/codespaces/prebuilding-your-codespaces/managing-prebuilds.md Co-authored-by: Laura Coursen <lecoursen@github.com> * Update content/codespaces/prebuilding-your-codespaces/managing-prebuilds.md Co-authored-by: Laura Coursen <lecoursen@github.com> * Update content/codespaces/prebuilding-your-codespaces/managing-prebuilds.md * Update content/codespaces/prebuilding-your-codespaces/managing-prebuilds.md Co-authored-by: Laura Coursen <lecoursen@github.com> * Update content/codespaces/prebuilding-your-codespaces/managing-prebuilds.md Co-authored-by: Laura Coursen <lecoursen@github.com> * Update content/codespaces/prebuilding-your-codespaces/managing-prebuilds.md Co-authored-by: Laura Coursen <lecoursen@github.com> * Update data/reusables/codespaces/billing-for-prebuilds.md * Update data/reusables/codespaces/billing-for-prebuilds.md Co-authored-by: Laura Coursen <lecoursen@github.com> * Move deletion points, as per review comment * Update link * Add links to new information * Make review comment changes * Update content/codespaces/prebuilding-your-codespaces/managing-prebuilds.md Co-authored-by: Jackie Jiménez <jaclynj@github.com> * Update content/codespaces/prebuilding-your-codespaces/testing-dev-container-changes.md * Update content/codespaces/prebuilding-your-codespaces/testing-dev-container-changes.md Co-authored-by: Jackie Jiménez <jaclynj@github.com> * Optimize images Co-authored-by: Mark Battistella <markbattistella@users.noreply.github.com> Co-authored-by: Emily Grace Seville <emilyseville7cf@gmail.com> Co-authored-by: Octomerger Bot <63058869+Octomerger@users.noreply.github.com> Co-authored-by: Anders Starcke Henriksen <starcke@github.com> Co-authored-by: Peter Bengtsson <mail@peterbe.com> Co-authored-by: Laura Coursen <lecoursen@github.com> Co-authored-by: lucie-docs <40564413+lucie-docs@users.noreply.github.com> Co-authored-by: Josh Johanning <joshjohanning@github.com> Co-authored-by: Tahlia G <84726379+tahlialouisa@users.noreply.github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Co-authored-by: Felicity Chapman <felicitymay@github.com> Co-authored-by: GitHub Actions <action@github.com> Co-authored-by: docubot <67483024+docubot@users.noreply.github.com> Co-authored-by: Simon Giesemann <kwacky1@github.com> Co-authored-by: Robert Sese <rsese@github.com> Co-authored-by: Mike Surowiec <mikesurowiec@users.noreply.github.com> Co-authored-by: Albin PK <56157868+albinpk@users.noreply.github.com> Co-authored-by: Dasun Tharanga <dasuntharangaflash@gmail.com> Co-authored-by: github-openapi-bot <69533958+github-openapi-bot@users.noreply.github.com> Co-authored-by: Ramya Parimi <33761166+ramyaparimi@users.noreply.github.com> Co-authored-by: github-openapi-bot <github-openapi-bot@users.noreply.github.com> Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com> Co-authored-by: Dorothy Mitchell <dorothymitchell@github.com> Co-authored-by: Andy J <mumfy@github.com> Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> Co-authored-by: Marko Kaznovac <kaznovac@users.noreply.github.com> Co-authored-by: Anil Seervi <61609033+AnilSeervi@users.noreply.github.com> Co-authored-by: Johanan Idicula <johanan@forcepush.tech> Co-authored-by: Jackie Jiménez <jaclynj@github.com> Co-authored-by: github-actions <github-actions@github.com>
44 lines
3.7 KiB
Markdown
44 lines
3.7 KiB
Markdown
---
|
|
title: GitHub Codespaces overview
|
|
shortTitle: Overview
|
|
product: '{% data reusables.gated-features.codespaces %}'
|
|
intro: 'This guide introduces {% data variables.product.prodname_codespaces %} and provides details on how it works and how to use it.'
|
|
allowTitleToDifferFromFilename: true
|
|
redirect_from:
|
|
- /codespaces/codespaces-reference/about-codespaces
|
|
- /github/developing-online-with-github-codespaces/about-github-codespaces
|
|
- /github/developing-online-with-codespaces/about-codespaces
|
|
- /codespaces/getting-started-with-codespaces/about-codespaces
|
|
- /codespaces/about-codespaces
|
|
versions:
|
|
fpt: '*'
|
|
ghec: '*'
|
|
type: overview
|
|
topics:
|
|
- Codespaces
|
|
---
|
|
|
|
## What is a codespace?
|
|
|
|
A codespace is a development environment that's hosted in the cloud. You can customize your project for {% data variables.product.prodname_codespaces %} by committing [configuration files](/codespaces/customizing-your-codespace/configuring-codespaces-for-your-project) to your repository (often known as Configuration-as-Code), which creates a repeatable codespace configuration for all users of your project.
|
|
|
|
{% data variables.product.prodname_codespaces %} run on a variety of VM-based compute options hosted by {% data variables.product.product_location %}, which you can configure from 2 core machines up to 32 core machines. You can connect to your codespaces from the browser or locally using {% data variables.product.prodname_vscode %}.
|
|
|
|

|
|
|
|
## Using Codespaces
|
|
|
|
You can create a codespace from any branch or commit in your repository and begin developing using cloud-based compute resources. {% data reusables.codespaces.links-to-get-started %}
|
|
|
|
To customize the runtimes and tools in your codespace, you can create a custom configuration to define an environment (or _dev container_) that is specific for your repository. Using a dev container allows you to specify a Docker environment for development with a well-defined tool and runtime stack that can reference an image, Dockerfile, or docker-compose. This means that anyone using the repository will have the same tools available to them when they create a codespace.
|
|
|
|
If you don't do any custom configuration, {% data variables.product.prodname_codespaces %} will clone your repository into an environment with the default codespace image that includes many tools, languages, and runtime environments. For more information, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)".
|
|
|
|
You can also personalize aspects of your codespace environment by using a public [dotfiles](https://dotfiles.github.io/tutorials/) repository and [Settings Sync](https://code.visualstudio.com/docs/editor/settings-sync). Personalization can include shell preferences, additional tools, editor settings, and VS Code extensions. For more information, see "[Customizing your codespace](/codespaces/customizing-your-codespace)".
|
|
|
|
## About billing for {% data variables.product.prodname_codespaces %}
|
|
|
|
For information on pricing, storage, and usage for {% data variables.product.prodname_codespaces %}, see "[Managing billing for {% data variables.product.prodname_codespaces %}](/billing/managing-billing-for-github-codespaces/about-billing-for-codespaces)."
|
|
|
|
{% data reusables.codespaces.codespaces-spending-limit-requirement %} For information on how organizations owners and billing managers can manage the spending limit for {% data variables.product.prodname_codespaces %} for an organization, see "[Managing your spending limit for {% data variables.product.prodname_codespaces %}](/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces)."
|