Merge branch 'main' into patch-1
BIN
assets/images/actions-job-summary-simple-example.png
Normal file
|
After Width: | Height: | Size: 32 KiB |
|
After Width: | Height: | Size: 48 KiB |
BIN
assets/images/help/classroom/org-view-codespaces-eligibility.png
Normal file
|
After Width: | Height: | Size: 101 KiB |
|
After Width: | Height: | Size: 100 KiB |
|
After Width: | Height: | Size: 64 KiB |
BIN
assets/images/help/classroom/student-codespaces-readme-link.png
Normal file
|
After Width: | Height: | Size: 18 KiB |
BIN
assets/images/help/classroom/student-launch-new-codespace.png
Normal file
|
After Width: | Height: | Size: 236 KiB |
|
After Width: | Height: | Size: 69 KiB |
@@ -157,6 +157,9 @@ We strongly recommend that actions use environment variables to access the files
|
||||
| `GITHUB_RUN_NUMBER` | {% data reusables.actions.run_number_description %} For example, `3`. |
|
||||
| `GITHUB_SERVER_URL`| The URL of the {% data variables.product.product_name %} server. For example: `https://{% data variables.product.product_url %}`.
|
||||
| `GITHUB_SHA` | The commit SHA that triggered the workflow. The value of this commit SHA depends on the event that triggered the workflow. For more information, see [Events that trigger workflows](/actions/using-workflows/events-that-trigger-workflows). For example, `ffac537e6cbbf934b08745a378932722df287a53`. |
|
||||
{%- if actions-job-summaries %}
|
||||
| `GITHUB_STEP_SUMMARY` | The path on the runner to the file that contains job summaries from workflow commands. This file is unique to the current step and changes for each step in a job. For example, `/home/rob/runner/_layout/_work/_temp/_runner_file_commands/step_summary_1cb22d7f-5663-41a8-9ffc-13472605c76c`. For more information, see "[Workflow commands for {% data variables.product.prodname_actions %}](/actions/using-workflows/workflow-commands-for-github-actions#adding-a-job-summary)." |
|
||||
{%- endif %}
|
||||
| `GITHUB_WORKFLOW` | The name of the workflow. For example, `My test workflow`. If the workflow file doesn't specify a `name`, the value of this variable is the full path of the workflow file in the repository. |
|
||||
| `GITHUB_WORKSPACE` | The default working directory on the runner for steps, and the default location of your repository when using the [`checkout`](https://github.com/actions/checkout) action. For example, `/home/runner/work/my-repo-name/my-repo-name`. |
|
||||
{%- if actions-runner-arch-envvars %}
|
||||
|
||||
@@ -110,6 +110,9 @@ The following table shows which toolkit functions are available within a workflo
|
||||
| `core.getInput` | Accessible using environment variable `INPUT_{NAME}` |
|
||||
| `core.getState` | Accessible using environment variable `STATE_{NAME}` |
|
||||
| `core.isDebug` | Accessible using environment variable `RUNNER_DEBUG` |
|
||||
{%- if actions-job-summaries %}
|
||||
| `core.summary` | Accessible using environment variable `GITHUB_STEP_SUMMARY` |
|
||||
{%- endif %}
|
||||
| `core.saveState` | `save-state` |
|
||||
| `core.setCommandEcho` | `echo` |
|
||||
| `core.setFailed` | Used as a shortcut for `::error` and `exit 1` |
|
||||
@@ -562,14 +565,16 @@ echo "{environment_variable_name}={value}" >> $GITHUB_ENV
|
||||
{% powershell %}
|
||||
|
||||
- Using PowerShell version 6 and higher:
|
||||
```pwsh{:copy}
|
||||
"{environment_variable_name}={value}" >> $env:GITHUB_ENV
|
||||
```
|
||||
|
||||
```pwsh{:copy}
|
||||
"{environment_variable_name}={value}" >> $env:GITHUB_ENV
|
||||
```
|
||||
|
||||
- Using PowerShell version 5.1 and below:
|
||||
```powershell{:copy}
|
||||
"{environment_variable_name}={value}" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
|
||||
```
|
||||
|
||||
```powershell{:copy}
|
||||
"{environment_variable_name}={value}" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
|
||||
```
|
||||
|
||||
{% endpowershell %}
|
||||
|
||||
@@ -656,6 +661,150 @@ steps:
|
||||
|
||||
{% endpowershell %}
|
||||
|
||||
{% if actions-job-summaries %}
|
||||
|
||||
## Adding a job summary
|
||||
|
||||
{% bash %}
|
||||
|
||||
```bash{:copy}
|
||||
echo "{markdown content}" >> $GITHUB_STEP_SUMMARY
|
||||
```
|
||||
|
||||
{% endbash %}
|
||||
|
||||
{% powershell %}
|
||||
|
||||
```pwsh{:copy}
|
||||
"{markdown content}" >> $env:GITHUB_STEP_SUMMARY
|
||||
```
|
||||
|
||||
{% endpowershell %}
|
||||
|
||||
You can set some custom Markdown for each job so that it will be displayed on the summary page of a workflow run. You can use job summaries to display and group unique content, such as test result summaries, so that someone viewing the result of a workflow run doesn't need to go into the logs to see important information related to the run, such as failures.
|
||||
|
||||
Job summaries support [{% data variables.product.prodname_dotcom %} flavored Markdown](https://github.github.com/gfm/), and you can add your Markdown content for a step to the `GITHUB_STEP_SUMMARY` environment file. `GITHUB_STEP_SUMMARY` is unique for each step in a job. For more information about the per-step file that `GITHUB_STEP_SUMMARY` references, see "[Environment files](#environment-files)."
|
||||
|
||||
When a job finishes, the summaries for all steps in a job are grouped together into a single job summary and are shown on the workflow run summary page. If multiple jobs generate summaries, the job summaries are ordered by job completion time.
|
||||
|
||||
### Example
|
||||
|
||||
{% bash %}
|
||||
|
||||
```bash{:copy}
|
||||
echo "### Hello world! :rocket:" >> $GITHUB_STEP_SUMMARY
|
||||
```
|
||||
|
||||
{% endbash %}
|
||||
|
||||
{% powershell %}
|
||||
|
||||
```pwsh{:copy}
|
||||
"### Hello world! :rocket:" >> $env:GITHUB_STEP_SUMMARY
|
||||
```
|
||||
|
||||
{% endpowershell %}
|
||||
|
||||

|
||||
|
||||
### Multiline Markdown content
|
||||
|
||||
For multiline Markdown content, you can use `>>` to continuously append content for the current step. With every append operation, a newline character is automatically added.
|
||||
|
||||
#### Example
|
||||
|
||||
{% bash %}
|
||||
|
||||
```yaml
|
||||
- name: Generate list using Markdown
|
||||
run: |
|
||||
echo "This is the lead in sentence for the list" >> $GITHUB_STEP_SUMMARY
|
||||
echo "" >> $GITHUB_STEP_SUMMARY # this is a blank line
|
||||
echo "- Lets add a bullet point" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- Lets add a second bullet point" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- How about a third one?" >> $GITHUB_STEP_SUMMARY
|
||||
```
|
||||
|
||||
{% endbash %}
|
||||
|
||||
{% powershell %}
|
||||
|
||||
```yaml
|
||||
- name: Generate list using Markdown
|
||||
run: |
|
||||
"This is the lead in sentence for the list" >> $env:GITHUB_STEP_SUMMARY
|
||||
"" >> $env:GITHUB_STEP_SUMMARY # this is a blank line
|
||||
"- Lets add a bullet point" >> $env:GITHUB_STEP_SUMMARY
|
||||
"- Lets add a second bullet point" >> $env:GITHUB_STEP_SUMMARY
|
||||
"- How about a third one?" >> $env:GITHUB_STEP_SUMMARY
|
||||
```
|
||||
|
||||
{% endpowershell %}
|
||||
|
||||
### Overwriting job summaries
|
||||
|
||||
To clear all content for the current step, you can use `>` to overwrite any previously added content.
|
||||
|
||||
#### Example
|
||||
|
||||
{% bash %}
|
||||
|
||||
```yaml
|
||||
- name: Overwrite Markdown
|
||||
run: |
|
||||
echo "Adding some Markdown content" >> $GITHUB_STEP_SUMMARY
|
||||
echo "There was an error, we need to clear the previous Markdown with some new content." > $GITHUB_STEP_SUMMARY
|
||||
```
|
||||
|
||||
{% endbash %}
|
||||
|
||||
{% powershell %}
|
||||
|
||||
```yaml
|
||||
- name: Overwrite Markdown
|
||||
run: |
|
||||
"Adding some Markdown content" >> $env:GITHUB_STEP_SUMMARY
|
||||
"There was an error, we need to clear the previous Markdown with some new content." > $env:GITHUB_STEP_SUMMARY
|
||||
```
|
||||
|
||||
{% endpowershell %}
|
||||
|
||||
### Removing job summaries
|
||||
|
||||
To completely remove a summary for the current step, the file that `GITHUB_STEP_SUMMARY` references can be deleted.
|
||||
|
||||
#### Example
|
||||
|
||||
{% bash %}
|
||||
|
||||
```yaml
|
||||
- name: Delete all summary content
|
||||
run: |
|
||||
echo "Adding Markdown content that we want to remove before the step ends" >> $GITHUB_STEP_SUMMARY
|
||||
rm $GITHUB_STEP_SUMMARY
|
||||
```
|
||||
|
||||
{% endbash %}
|
||||
|
||||
{% powershell %}
|
||||
|
||||
```yaml
|
||||
- name: Delete all summary content
|
||||
run: |
|
||||
"Adding Markdown content that we want to remove before the step ends" >> $env:GITHUB_STEP_SUMMARY
|
||||
rm $env:GITHUB_STEP_SUMMARY
|
||||
```
|
||||
|
||||
{% endpowershell %}
|
||||
|
||||
After a step has completed, job summaries are uploaded and subsequent steps cannot modify previously uploaded Markdown content. Summaries automatically mask any secrets that might have been added accidentally. If a job summary contains sensitive information that must be deleted, you can delete the entire workflow run to remove all its job summaries. For more information see "[Deleting a workflow run](/actions/managing-workflow-runs/deleting-a-workflow-run)."
|
||||
|
||||
### Step isolation and limits
|
||||
|
||||
Job summaries are isolated between steps and each step is restricted to a maximum size of 1MiB. Isolation is enforced between steps so that potentially malformed Markdown from a single step cannot break Markdown rendering for subsequent steps. If more than 1MiB of content is added for a step, then the upload for the step will fail and an error annotation will be created. Upload failures for job summaries do not affect the overall status of a step or a job. A maximum of 20 job summaries from steps are displayed per job.
|
||||
|
||||
{% endif %}
|
||||
|
||||
## Adding a system path
|
||||
|
||||
Prepends a directory to the system `PATH` variable and automatically makes it available to all subsequent actions in the current job; the currently running action cannot access the updated path variable. To see the currently defined paths for your job, you can use `echo "$PATH"` in a step or an action.
|
||||
@@ -677,21 +826,20 @@ echo "{path}" >> $GITHUB_PATH
|
||||
|
||||
### Example
|
||||
|
||||
This example demonstrates how to add the user `$HOME/.local/bin` directory to `PATH`:
|
||||
|
||||
{% bash %}
|
||||
|
||||
This example demonstrates how to add the user `$HOME/.local/bin` directory to `PATH`:
|
||||
|
||||
```bash{:copy}
|
||||
echo "$HOME/.local/bin" >> $GITHUB_PATH
|
||||
```
|
||||
|
||||
{% endbash %}
|
||||
|
||||
{% powershell %}
|
||||
|
||||
This example demonstrates how to add the user `$env:HOMEPATH/.local/bin` directory to `PATH`:
|
||||
|
||||
{% powershell %}
|
||||
|
||||
```pwsh{:copy}
|
||||
"$env:HOMEPATH/.local/bin" >> $env:GITHUB_PATH
|
||||
```
|
||||
|
||||
@@ -32,6 +32,13 @@ By default, a codespace can only access the repository from which it was created
|
||||
|
||||
## Enable {% data variables.product.prodname_codespaces %} for users in your organization
|
||||
|
||||
{% ifversion fpt %}
|
||||
{% note %}
|
||||
|
||||
**Note:** If you are a verified educator or a teacher, you must enable {% data variables.product.prodname_codespaces %} from a {% data variables.product.prodname_classroom %} to use your {% data variables.product.prodname_codespaces %} Education benefit. For more information, see "[Using GitHub Codespaces with GitHub Classroom](/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/using-github-codespaces-with-github-classroom#about-the-codespaces-education-benefit-for-verified-teachers)."
|
||||
|
||||
{% endnote %}
|
||||
{% endif %}
|
||||
{% data reusables.profile.access_org %}
|
||||
{% data reusables.profile.org_settings %}
|
||||
{% data reusables.organizations.click-codespaces %}
|
||||
|
||||
@@ -87,7 +87,7 @@ To create codespaces with custom permissions defined, you must use one of the fo
|
||||
}
|
||||
```
|
||||
|
||||
To set all permissions for a given repository, use `read-all` or `write-all` in the `permissions` object
|
||||
To set all permissions for a given repository, use `"permissions": "read-all"` or `"permissions": "write-all"` in the repository object.
|
||||
|
||||
```json
|
||||
{
|
||||
@@ -95,9 +95,7 @@ To create codespaces with custom permissions defined, you must use one of the fo
|
||||
"codespaces": {
|
||||
"repositories": {
|
||||
"my_org/my_repo": {
|
||||
"permissions": {
|
||||
"write-all"
|
||||
}
|
||||
"permissions": "write-all"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -10,11 +10,11 @@ versions:
|
||||
fpt: '*'
|
||||
shortTitle: For students
|
||||
---
|
||||
Using {% data variables.product.prodname_dotcom %} for your school projects is a practical way to collaborate with others and build a portfolio that showcases real-world experience.
|
||||
|
||||
{% data reusables.education.about-github-education-link %}
|
||||
|
||||
Everyone with a {% data variables.product.prodname_dotcom %} account can collaborate in unlimited public and private repositories with {% data variables.product.prodname_free_user %}. As a student, you can also apply for GitHub Student benefits, which includes access to GitHub Global Campus, a digital campus for our GitHub student community to take advantage of some of the best programs that GitHub Education has to offer. GitHub Global Campus includes the {% data variables.product.prodname_student_pack %}, which offers free access to tools and services used by professional developers, as well as access to [Campus TV](https://www.twitch.tv/githubeducation) content, student events, GitHub Classroom Assignments, and much more, to help students with their technical career goals. For more information, see "[Apply for a student developer pack](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/apply-for-a-student-developer-pack)" and [{% data variables.product.prodname_education %}](https://education.github.com/).
|
||||
Using {% data variables.product.prodname_dotcom %} for your school projects is a practical way to collaborate with others and build a portfolio that showcases real-world experience.
|
||||
|
||||
Everyone with a {% data variables.product.prodname_dotcom %} account can collaborate in unlimited public and private repositories with {% data variables.product.prodname_free_user %}. As a student, you can also apply for GitHub Student benefits. For more information, see "[Apply for a student developer pack](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/apply-for-a-student-developer-pack)" and [{% data variables.product.prodname_education %}](https://education.github.com/).
|
||||
|
||||
If you're a member of a FIRST robotics club, your mentor can apply for an educator discount so your team can collaborate using {% data variables.product.prodname_team %}, which allows unlimited users and private repositories, for free. For more information, see "[Apply for an educator or researcher discount](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/apply-for-an-educator-or-researcher-discount)."
|
||||
|
||||
|
||||
@@ -6,6 +6,7 @@ versions:
|
||||
fpt: '*'
|
||||
children:
|
||||
- /integrate-github-classroom-with-an-ide
|
||||
- /using-github-codespaces-with-github-classroom
|
||||
- /about-using-visual-studio-code-with-github-classroom
|
||||
- /about-using-makecode-arcade-with-github-classroom
|
||||
- /replit-with-github-classroom
|
||||
|
||||
@@ -22,6 +22,7 @@ After a student accepts an assignment with an IDE, the README file in the studen
|
||||
|
||||
| IDE | More information |
|
||||
| :- | :- |
|
||||
| {% data variables.product.prodname_github_codespaces %} | "[Using {% data variables.product.prodname_github_codespaces %} with {% data variables.product.prodname_classroom %}](/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/using-github-codespaces-with-github-classroom)" |
|
||||
| Microsoft MakeCode Arcade | "[About using MakeCode Arcade with {% data variables.product.prodname_classroom %}](/education/manage-coursework-with-github-classroom/about-using-makecode-arcade-with-github-classroom)" |
|
||||
| Visual Studio Code | [{% data variables.product.prodname_classroom %} extension](http://aka.ms/classroom-vscode-ext) in the Visual Studio Marketplace |
|
||||
|
||||
@@ -31,11 +32,13 @@ We know cloud IDE integrations are important to your classroom and are working t
|
||||
|
||||
You can choose the IDE you'd like to use for an assignment when you create an assignment. To learn how to create a new assignment that uses an IDE, see "[Create an individual assignment](/education/manage-coursework-with-github-classroom/create-an-individual-assignment)" or "[Create a group assignment](/education/manage-coursework-with-github-classroom/create-a-group-assignment)."
|
||||
|
||||
## Authorizing the OAuth app for an IDE
|
||||
## Setting up an assignment in a new IDE
|
||||
|
||||
The first time you configure an assignment with an IDE, you must authorize the OAuth app for the IDE for your organization.
|
||||
The first time you configure an assignment using a different IDE, you must ensure that it is set up correctly.
|
||||
|
||||
For all repositories, grant the app **read** access to metadata, administration, and code, and **write** access to administration and code. For more information, see "[Authorizing OAuth Apps](/github/authenticating-to-github/authorizing-oauth-apps)."
|
||||
Unless you use {% data variables.product.prodname_github_codespaces %}, you must authorize the OAuth app for the IDE for your organization. For all repositories, grant the app **read** access to metadata, administration, and code, and **write** access to administration and code. For more information, see "[Authorizing OAuth Apps](/github/authenticating-to-github/authorizing-oauth-apps)."
|
||||
|
||||
{% data variables.product.prodname_github_codespaces %} does not require an OAuth app, but you need to enable {% data variables.product.prodname_github_codespaces %} for your organization to be able to configure an assignment with {% data variables.product.prodname_codespaces %}. For more information, see "[Using {% data variables.product.prodname_github_codespaces %} with {% data variables.product.prodname_classroom %}](/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/using-github-codespaces-with-github-classroom#enabling-codespaces-for-your-organization)."
|
||||
|
||||
## Further reading
|
||||
|
||||
|
||||
@@ -0,0 +1,84 @@
|
||||
---
|
||||
title: Using GitHub Codespaces with GitHub Classroom
|
||||
shortTitle: Using Codespaces with GitHub Classroom
|
||||
product: '{% data reusables.gated-features.codespaces-classroom-articles %}'
|
||||
intro: 'You can use {% data variables.product.prodname_github_codespaces %} as the preferred editor in your assignments to give students access to a browser-based Visual Studio Code environment with one-click setup.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
permissions: 'Organization owners who are admins for a classroom can enable {% data variables.product.prodname_github_codespaces %} for their organization and integrate {% data variables.product.prodname_github_codespaces %} as the supported editor for an assignment. {% data reusables.classroom.classroom-admins-link %}'
|
||||
---
|
||||
## About {% data variables.product.prodname_codespaces %}
|
||||
|
||||
{% data variables.product.prodname_github_codespaces %} is an instant, cloud-based development environment that uses a container to provide you with common languages, tools, and utilities for development. {% data variables.product.prodname_codespaces %} is also configurable, allowing you to create a customized development environment that is the same for all users of your project. For more information, see "[{% data variables.product.prodname_github_codespaces %} overview](/codespaces/overview)."
|
||||
|
||||
Once {% data variables.product.prodname_codespaces %} is enabled in an organization or enterprise, users can create a codespace from any branch or commit in an organization or enterprise repository and begin developing using cloud-based compute resources. You can connect to a codespace from the browser or locally using Visual Studio Code. {% data reusables.codespaces.links-to-get-started %}
|
||||
|
||||
Setting {% data variables.product.prodname_codespaces %} as the preferred editor for an assignment in GitHub Classroom assignments, is beneficial for both students and teachers. {% data variables.product.prodname_codespaces %} is a good option for students using loaned devices or without access to a local IDE setup, since each codespace is cloud-based and requires no local setup. Students can launch a codespace for an assignment repository in Visual Studio Code directly in their browser, and begin developing right away without needing any further configuration.
|
||||
|
||||
For assignments with complex setup environments, teachers can customize the dev container configuration for a repository's codespaces. This ensures that when a student creates a codespace, it automatically opens with the development environment configured by the teacher. For more information on dev containers, see "[Introduction to dev containers](/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers)."
|
||||
|
||||
## About the {% data variables.product.prodname_codespaces %} Education benefit for verified teachers
|
||||
|
||||
The {% data variables.product.prodname_codespaces %} Education benefit gives verified teachers a free monthly allowance of {% data variables.product.prodname_codespaces %} hours to use in {% data variables.product.prodname_classroom %}. The free allowance is estimated to be enough for a class of 50 with 5 assignments per month, on a 2 core machine with 1 codespace stored per student.
|
||||
|
||||
{% data reusables.classroom.free-limited-codespaces-for-verified-teachers-beta-note %}
|
||||
|
||||
To become a verified teacher, you need to be approved for an educator or teacher benefit. For more information, see "[Applying for an educator or teacher benefit](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-in-your-classroom-and-research/apply-for-an-educator-or-researcher-discount#applying-for-an-educator-or-researcher-discount)."
|
||||
|
||||
If you are eligible for the {% data variables.product.prodname_codespaces %} Education benefit, when you enable {% data variables.product.prodname_codespaces %} in {% data variables.product.prodname_classroom %} for your organization, GitHub automatically adds a Codespace policy to restrict machine types for all codespaces in the organization to 2 core machines. This helps you make the most of the free {% data variables.product.prodname_codespaces %} usage. However, you can change or remove these policies in your organization settings. For more information, see "[Restricting access to machine types](/codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types)."
|
||||
|
||||
When the {% data variables.product.prodname_codespaces %} Education benefit moves out of beta, if your organization exceeds their free allowance for {% data variables.product.prodname_codespaces %} usage, your organization will be billed for additional usage. For more information, see "[About billing for {% data variables.product.prodname_codespaces %}](/billing/managing-billing-for-github-codespaces/about-billing-for-codespaces#about-billing-for-codespaces)."
|
||||
|
||||
## Enabling {% data variables.product.prodname_codespaces %} for your organization
|
||||
|
||||
{% data variables.product.prodname_codespaces %} is available to use with {% data variables.product.prodname_classroom %} for organizations that use {% data variables.product.prodname_team %}. If you are eligible for the {% data variables.product.prodname_codespaces %} Education benefit, you must enable {% data variables.product.prodname_codespaces %} through {% data variables.product.prodname_classroom %}, instead of enabling it directly in your organization settings. Otherwise, your organization will be billed directly for all usage of {% data variables.product.prodname_codespaces %}.
|
||||
|
||||
### Enabling Codespaces for an organization when creating a new classroom
|
||||
{% data reusables.classroom.sign-into-github-classroom %}
|
||||
1. Click **New classroom**.
|
||||
|
||||

|
||||
|
||||
1. In the list of organizations, click the organization you'd like to use for your classroom. Organizations that are eligible for {% data variables.product.prodname_codespaces %} will have a note showing that they are eligible. Optionally, you can create a new organization. For more information, see "[Creating a new organization from scratch](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)."
|
||||
|
||||

|
||||
|
||||
1. In the "Name your classroom" page, under "{% data variables.product.prodname_codespaces %} in your Classroom", click **Enable**. Note that this will enable {% data variables.product.prodname_codespaces %} for all repositories and users in the organization.
|
||||
|
||||

|
||||
|
||||
1. When you are ready to create the new classroom, click **Create classroom**.
|
||||
|
||||
### Enabling Codespaces for an organization via an existing classroom
|
||||
|
||||
{% data reusables.classroom.sign-into-github-classroom %}
|
||||
{% data reusables.classroom.click-classroom-in-list %}
|
||||
{% data reusables.classroom.click-settings %}
|
||||
1. Under "{% data variables.product.prodname_github_codespaces %}", click **Enable**. This will enable {% data variables.product.prodname_codespaces %} for all repositories and users in the organization. A new Codespace policy is also added to restrict machine types for all codespaces in the organization to 2 core machines.
|
||||
|
||||

|
||||
|
||||
You can use the same methods as above to disable {% data variables.product.prodname_codespaces %} for your organization as well. Note that this will disable {% data variables.product.prodname_codespaces %} for all users and repositories in the organization.
|
||||
|
||||
## Configuring an assignment to use {% data variables.product.prodname_codespaces %}
|
||||
To make {% data variables.product.prodname_codespaces %} available to students for an assignment, you can choose {% data variables.product.prodname_codespaces %} as the supported editor for the assignment. When creating a new assignment, in the "Add your starter code and choose your optional online IDE" page, under "Add a supported editor", select **{% data variables.product.prodname_github_codespaces %}** from the dropdown menu.
|
||||
|
||||

|
||||
|
||||
If you use a template repository for an assignment, you can define a dev container in the repository to customize the tools and runtimes available to students when they launch a codespace to work on the assignment. If you do not define a dev container, {% data variables.product.prodname_github_codespaces %} will use a default configuration, which contains many of the common tools that your students might need for development. For more information on defining a dev container, see "[Add a dev container configuration to your repository](/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces)."
|
||||
|
||||
## Launching an assignment using {% data variables.product.prodname_codespaces %}
|
||||
|
||||
When a student opens an assignment, the repository's README file includes their teacher's recommendation of the IDE they should use for the work.
|
||||
|
||||

|
||||
|
||||
Students can launch a new or existing codespace by clicking the **{% octicon "code" aria-label="The code icon" %} Code** button on the main page of the assignment repository, then selecting the **Codespaces** tab. For more information, see "[Creating a codespace](/codespaces/developing-in-codespaces/creating-a-codespace#creating-a-codespace)."
|
||||
|
||||

|
||||
|
||||
Teachers can view each student's codespace for an assignment in the assignment overview page. You can click on the Codespaces icon on the right side of each student row to launch the codespace.
|
||||
|
||||

|
||||
|
||||
When you connect to a codespace through a browser, auto-save is enabled automatically. If you want to save changes to the repository, you will need to commit the changes and push them to a remote branch. If you leave your codespace running without interaction for 30 minutes by default, the codespace will timeout and stop running. Your data will be preserved from the last time you made a change. For more information on the lifecycle of a codespace, see "[Codespaces lifecycle](/codespaces/developing-in-codespaces/codespaces-lifecycle)."
|
||||
@@ -95,6 +95,8 @@ By default, a new assignment will create an empty repository for each team that
|
||||
|
||||
{% data reusables.classroom.about-online-ides %} For more information, see "[Integrate {% data variables.product.prodname_classroom %} with an IDE](/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide)."
|
||||
|
||||
{% data reusables.classroom.classroom-codespaces-link %}
|
||||
|
||||
{% data reusables.classroom.assignments-guide-choose-an-online-ide %}
|
||||
|
||||
{% data reusables.classroom.assignments-guide-click-continue-after-starter-code-and-feedback %}
|
||||
|
||||
@@ -77,6 +77,8 @@ By default, a new assignment will create an empty repository for each student on
|
||||
|
||||
{% data reusables.classroom.about-online-ides %} For more information, see "[Integrate {% data variables.product.prodname_classroom %} with an IDE](/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide)."
|
||||
|
||||
{% data reusables.classroom.classroom-codespaces-link %}
|
||||
|
||||
{% data reusables.classroom.assignments-guide-choose-an-online-ide %}
|
||||
|
||||
## Providing feedback for an assignment
|
||||
|
||||
7
data/features/actions-job-summaries.yml
Normal file
@@ -0,0 +1,7 @@
|
||||
# Reference: #6405
|
||||
# Documentation for job summaries for jobs on the workflow run summary page.
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
ghes: '>3.5'
|
||||
ghae: 'issue-6405'
|
||||
@@ -1,5 +1,5 @@
|
||||
To choose an IDE for the assignment, select the Add an editor drop-down menu and click the IDE you'd like your students to use.
|
||||
|
||||
<div class="procedural-image-wrapper">
|
||||
<img alt="Using the 'Select an online IDE' drop-down menu to click an online IDE for the assignment" class="procedural-image-wrapper" src="/assets/images/help/classroom/assignments-click-online-ide.png">
|
||||
<img alt="Using the 'Select an online IDE' drop-down menu to click an online IDE for the assignment" class="procedural-image-wrapper" src="/assets/images/help/classroom/select-supported-editor-including-codespaces.png">
|
||||
</div>
|
||||
|
||||
1
data/reusables/classroom/classroom-codespaces-link.md
Normal file
@@ -0,0 +1 @@
|
||||
You can choose to configure an assignment with {% data variables.product.prodname_github_codespaces %} to give students access to a browser-based Visual Studio Code environment with one-click setup. For more information, see "[Using {% data variables.product.prodname_github_codespaces %} with {% data variables.product.prodname_classroom %}](/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/using-github-codespaces-with-github-classroom)."
|
||||
@@ -0,0 +1,5 @@
|
||||
{% note %}
|
||||
|
||||
**Note**: The {% data variables.product.prodname_codespaces %} Education benefit is currently in public beta and subject to change. During the beta release, your organization will not be charged if you exceed the free allowance.
|
||||
|
||||
{% endnote %}
|
||||
@@ -1 +1,3 @@
|
||||
As a student or faculty member at an accredited educational institution, you can apply for GitHub Education benefits, which includes access to GitHub Global Campus. Global Campus is a portal that allows the GitHub Education Community to access their education benefits—all in one place! The Global Campus portal includes access to the GitHub Education Community, industry tools used by professional developers, events, [Campus TV](https://www.twitch.tv/githubeducation) content, GitHub Classroom, and other exclusive features to help students and teachers shape the next generation of software development.
|
||||
|
||||
Before applying for an individual discount, check if your learning community is already partnered with us as a {% data variables.product.prodname_campus_program %} school. For more information, see "[About {% data variables.product.prodname_campus_program %}](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/about-github-campus-program)."
|
||||
|
||||
@@ -0,0 +1 @@
|
||||
Codespaces is available to use with {% data variables.product.prodname_classroom %} for organizations that use {% data variables.product.prodname_team %}. To find out if you qualify for a free upgrade to {% data variables.product.prodname_team %}, see "[Apply for an educator or researcher discount](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-in-your-classroom-and-research/apply-for-an-educator-or-researcher-discount)."
|
||||
@@ -1,2 +1,3 @@
|
||||
1. From the list of workflow runs, click the name of the run you want to see.
|
||||

|
||||
1. From the list of workflow runs, click the name of the run to see the workflow run summary.
|
||||
|
||||

|
||||
|
||||