Skip to content

Commit c42a162

Browse files
committed
Update guided workshop exercises for clarity and accuracy in instructions
1 parent 51cf52a commit c42a162

File tree

5 files changed

+24
-18
lines changed

5 files changed

+24
-18
lines changed

content/guided-workshop/exercises/1-code-scanning.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,12 @@ Public repositories on GitHub automatically have Dependabot alerts. This feature
2424

2525
1. Navigate to the repository you created for this workshop.
2626
1. Select the **Settings** tab.
27-
1. On the left side, select **Code security and analysis**.
28-
1. Locate the **Dependabot** section towards the middle of the page:
27+
2. On the left side, select **Code security**.
28+
3. Locate the **Dependabot** section towards the middle of the page:
2929

3030
![Screenshot of the dependabot section](./images/1-dependabot.png)
3131

32-
1. Select **Enable** next to **Dependabot security updates** to configure Dependabot to create PRs to resolve alerts.
32+
4. Select **Enable** next to **Dependabot security updates** to configure Dependabot to create PRs to resolve alerts.
3333

3434
You have now enabled Dependabot alerts and security updates! Should an insecure library be detected, you will both receive an alert, and Dependabot will create a new pull request to update the version number to a secure version of the library.
3535

content/guided-workshop/exercises/2-issues.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,9 @@ Our project needs two main updates. We want to make the updates to support devel
2323
1. Return to the repository you created at the beginning of this workshop.
2424
1. Select the **Issues** tab.
2525
1. Select **New issue**.
26-
1. Create new issues by adding the information indicated in the table below, selecting **Submit new issue** after creating each one (and using **New issue** to create a new one):
26+
2. If prompted for type, select **Blank issue**.
27+
3. Select **Create more** at the bottom of the page to streamline the creation process.
28+
4. Create new issues by adding the information indicated in the table below, selecting **Submit new issue** after creating each one:
2729

2830
| Title | Description |
2931
| ----------------------- | ------------------------------------------------------------------------------ |

content/guided-workshop/exercises/3-codespaces.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,20 +21,20 @@ One thing that's really great is the [default dev container](https://github.com/
2121
Let's create our own dev container! The [dev container is configured](https://docs.github.com/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers) by creating the Docker files Codespaces will use to create and configure the container, and providing any customizations in the `devcontainer.json` file. Customizations provided in `devcontainer.json` can include ports to open, commands to run, and extension to install in Visual Studio Code (either running locally on the desktop or in the browser). This configuration becomes part of the repository. All developers who wish to contribute can then create a new instance of the container based on the configuration you provided.
2222

2323
1. Access the Command Palette (<kbd>F1</kbd> or clicking ☰ → View → Command Palette), then start typing **dev container**.
24-
1. Select **Codespaces: Add Development Container Configuration Files...** .
25-
2. Select **Add configuration to workspace**.
24+
2. Select **Codespaces: Add Development Container Configuration Files...** .
2625
3. Select **Create a new configuration...**.
27-
4. Select **From a predefined container configuration...**.
28-
5. Scroll down and select **Node.js & TypeScript**.
29-
6. Select **22-bookworm (default)**.
30-
7. Select the following features to add into your container:
26+
4. Scroll down and select **Node.js & TypeScript**.
27+
5. Select **22-bookworm (default)**.
28+
6. Select the following features to add into your container:
3129
- **GitHub CLI**
3230
- **Python**
3331

3432
> [!NOTE]
3533
> You can type the name of the feature you want to filter the list.
3634
37-
8. Select **Keep defaults** to use the default configuration.
35+
7. Select **OK** to add the features.
36+
8. Select **Keep defaults** to use the default configuration.
37+
9. If you receive the prompt **File './.github/dependabot.yml' already exists, overwrite?**, select **Skip**.
3838

3939
> [!IMPORTANT]
4040
> Your new container definition files will be created into the **.devcontainer** folder. **DO NOT** select **Rebuild Now**; we'll do that in just a moment.
@@ -98,11 +98,13 @@ You've now defined a custom container!
9898

9999
Whenever someone uses the codespace you defined they'll have an environment with Node.js and Mongo DB, and the GitHub Copilot extension installed. Let's use this container!
100100

101-
1. Open the command palette.
101+
1. Access the Command Palette (<kbd>F1</kbd> or clicking ☰ → View → Command Palette), then start typing **dev container**.
102102
1. Type **rebuild** and select **Codespaces: Rebuild container**.
103103
1. Select **Rebuild Container** on the dialog box. Your container now rebuilds.
104104

105105
> **IMPORTANT:** Rebuilding the container can take several minutes. Obviously this isn't an ideal situation for providing fast access to your developers, even if it's faster than creating everything from scratch. Fortunately you can [prebuild your codespaces](https://docs.github.com/en/codespaces/prebuilding-your-codespaces) to ensure developers can spin one up within seconds.
106+
>
107+
> You may also be prompted to reload the window as extensions install. Reload the window as prompted.
106108

107109
## Interacting with the repository
108110

content/guided-workshop/exercises/4-testing.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,14 +46,15 @@ Now that we have an overview of the structure of a workflow, let's ask Copilot t
4646

4747
1. Create a new folder under **.github** named **workflows**.
4848
2. Create a new file named **server-test.yml** and ensure the file is open.
49-
3. Open GitHub Copilot Chat.
50-
4. Add the test file **test_app.py** to the context by using the `#` in the Chat dialog box and beginning to type **test_app.py**, and pressing <kbd>enter</kbd> when it's highlighted.
51-
5. Prompt Copilot to create a GitHub Action workflow to run the tests. Use natural language to describe the workflow you're looking to create (to run the tests defined in test_app.py), and that you want it to run on merge (for when new code is pushed), when a PR is made, and on demand.
49+
3. If prompted to install the **GitHub Actions** extension, select **Install**.
50+
4. Open GitHub Copilot Chat.
51+
5. Add the test file **test_app.py** to the context by using the `#` in the Chat dialog box and beginning to type **test_app.py**, and pressing <kbd>enter</kbd> when it's highlighted.
52+
6. Prompt Copilot to create a GitHub Action workflow to run the tests. Use natural language to describe the workflow you're looking to create (to run the tests defined in test_app.py), and that you want it to run on merge (for when new code is pushed), when a PR is made, and on demand.
5253

5354
> [!IMPORTANT]
5455
> A prescriptive prompt isn't provided as part of the exercise is to become comfortable interacting with GitHub Copilot.
5556
56-
6. Add the generated code to the new file. It should resemble the following:
57+
6. Add the generated code to the new file by hovering over the suggested code and selecting the **Insert at cursor** button. The generated code should resemble the following:
5758

5859
```yml
5960
name: Server Tests

content/guided-workshop/exercises/5-context.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,9 @@ GitHub Copilot Chat has a set of available chat participants and extensions avai
2424
2525
1. Return to your codespace, or reopen it by navigating to your repository and selecting **Code** > **Codespaces** and the name of your codespace.
2626
2. Open GitHub Copilot Chat.
27-
3. Type `@workspace` in the chat prompt window and hit <kbd>tab</kbd> to select or activate it, then continue by asking Copilot about your project. You can ask what technologies are in use, what the project does, where functionality resides, etc.
28-
4. Spend a few minutes exploring to find the answers to the following questions:
27+
3. Select the `+` icon towards the top to begin a new chat.
28+
4. Type `@workspace` in the chat prompt window and hit <kbd>tab</kbd> to select or activate it, then continue by asking Copilot about your project. You can ask what technologies are in use, what the project does, where functionality resides, etc.
29+
5. Spend a few minutes exploring to find the answers to the following questions:
2930
- What frameworks are currently in use?
3031
- Where's the database the project uses?
3132
- How is the frontend built?

0 commit comments

Comments
 (0)