Skip to content

Latest commit

 

History

History
712 lines (451 loc) · 42.9 KB

labs.md

File metadata and controls

712 lines (451 loc) · 42.9 KB

Hands-on Workshop

GitHub Copilot - The World’s Most Widely Adopted AI Developer Tool

Revision 1.1 - 06/21/24

NOTE: To copy and paste in the codespace, you may need to use keyboard commands - CTRL-C and CTRL-V (Or, the appropriate keyboard commands for your OS).

Introduction

Welcome to the GitHub Copilot Hands-On Workshop! In this workshop, you will learn how to use GitHub Copilot, the world's most widely adopted AI developer tool. GitHub Copilot is an AI pair programmer that helps you write code faster and with fewer errors. It is powered by OpenAI's Large Language Model (LLM), which is a state-of-the-art language model trained on a diverse range of data sources, including publicly available code from GitHub. GitHub Copilot is available as a Visual Studio Code extension and can be used in any language, including Python, JavaScript, TypeScript, Go, Ruby, Java, C++, and many more.

Before you begin

1. Follow the startup instructions in the README.md file IF NOT ALREADY DONE!

2. Reivew the GitHub Copilot Extension installation

One of the advantages of using GitHub Codespaces for this workshop is that GitHub Copilot is preconfigured for you.

  1. Open .devcontainer/devcontainer.json.

  2. If it is not visible, scroll down until you see the "extensions" section.

  3. Notice how the GitHub.copilot and GitHub.copilot-chat extensions are already installed.

GitHub Copilot Extensions are already installed

If you were using the Visual Studio Code application, you would have to manually install the GitHub Copilot extensions. Refer to Set up GitHub Copilot in VS Code for step-by-step instructions.

NOTE: You can also use GitHub Copilot in Visual Studio and compatible JetBrains IDEs.

You can now close .devcontainer/devcontainer.json as we do not need this for anything else in this lab.

3. Configure your desktop to make LABS.MD always visible

Before we begin, we will configure the browser windows to make the labs.md file always visible. This will allow you to easily switch between the lab instructions and any editor windows you have open.

  1. Select the labs.md tab and drag it down so that it moves into a separate window.

  2. If you are on Windows, you can "snap" the labs.md tab to one side or another and select the Codespace tab as the adjacent window.

  3. Move the vertical slider until you can comfortably see the instructions in labs.md and the Codespace side by side.

Now we can see the labs.md file to one side of the screen while we are executing the actions in the Codespace on the other side of the screen. If needed, adjust the zoom level in either or both windows as desired.

Split View

4. Let us know how we are doing

We are leveraging GitHub Discussions located in this repository for real time issue reporting, feedback and suggestions.

Lab 1 - Learning how to create good prompts for Copilot

Purpose: In this lab, we’ll start to learn about Copilot and how it generates code based on the prompts we provide

  1. Create a new file. In the terminal, enter

    code index.js
    
  2. Afterwards this file should be open in a tab in the editor.

  3. Let's see how Copilot responds to a generic request. Go to that tab and type in a comment that says

// function to parse data
  1. Hit return and notice the code that Copilot suggested. This is likely more generic than we want, but hit tab to select that line.

  2. After hitting tab, Copilot will generate another part of the function. (If not, you may need to hit return.) Hit tab to accept it. Continue until you get a complete function. One example of what code may look like is below.

Copilot generated function

  1. This prompt is not specific enough for Copilot to interpret what we want to do. Highlight the code and delete it, so we can try again.

  2. Now type a comment at the top that says

// function to parse url
  1. Hit enter and you will probably see a similar line to
function parseURL(url) {
  1. Just hit Tab to accept it and Enter again. After that Copilot may or may not offer a suggestion. If it does, great - you can just hit Tab and accept it. If not, it may be necessary to further "nudge" Copilot by giving more prompts. Only if you're not getting responses from Copilot, hit return and type the comment below to nudge Copilot.
// parse url

nudge comment

  1. Only if needed, hit return and Copilot should start generating suggestions again. You can just hit tab to accept each line and then return to get the next part of the code until the function is complete. You may get some blank lines along the way - just hit return until you get to the end of a function. (You will be at the end when the indentation is done. Also Copilot may start to suggest another function in comments like // test...)

  2. Suppose you're not happy with that suggestion. Copilot can provide other options for the code. To see those, make sure you are in the editor for the file, highlight/select the existing code and hit Ctrl + Enter. A second window will open up with other suggestions. Be patient - it takes a bit of time for Copilot to generate alternative suggestions. After a moment though, you will have up to 10 alternatives to pick from. You can scan through these and then pick a different one if you want by clicking on the "Accept Solution" button under the alternative suggestion. Note that this will add the code to the existing set, so you may want to delete the other code first.

alternative suggestions

  1. Let's do one more pass at getting a specific prompt for Copilot. Delete all the code currently in index.js. This time we will not enter a comment, but will enter a specific function name. Type the following in the empty file. (There are no parentheses after the splitURLandReturnComponents text.) Do not hit tab or return yet.
function splitURLandReturnComponents
  1. With this function name, Copilot should suggest a full function definition - in fact it may suggest several. To see the options, hover over the first line and a small window should appear. This window will not how many options there are (probably 2 or 3) and provide "<" and ">" links to toggle between them. Click on the "<" and ">" buttons to see the differences in the available suggestions.

alternative suggestions inline

  1. When you find an alternative you like, go ahead and tab to select it.

=========== END OF LAB ===========

Lab 2 - Using Copilot to simplify and explain code

  1. Create a new file named prime.py. Create it via the same process as we used in Lab 1 by entering the line below in the terminal.
code prime.py
  1. Start typing a function definition as below
def is_prime(n
  1. Hit Ctrl+Enter to see options

  2. Pick one of the options that is longer and/or more complex (if there is one) and Accept Solution. If there's not one that's longer/more complex, just pick an alternative one and Accept Solution.

alternative suggestions

  1. Highlight the code and select the Chat extension icon to open the chat window. Tell Copilot to simplify the code by typing in the chat window.
simplify

simplifying via chat box

  1. Hover over the simplified text and tell Copilot to insert the suggestion at the cursor to replace the text that's currently there.

replace from chat suggestion

  1. Now, let's introduce an error into the code to see how Copilot can fix it. Pick an instance of a variable name and change it to one that doesn't exist. For example, change an instance of "n" to "x".

introduce error

  1. Notice the light bulb icon that has popped up. Click on that, scroll to the bottom (if needed), and you'll have additional options to fix or explain with Copilot.

Copilot options inline

  1. Go ahead and click on the "Fix using Copilot" option.

  2. After a few moments, it will propose a fix that you can just accept (via the Accept button).

Fixing with Copilot

  1. (Optional) If you'd like, you can go back and make the error again, highlight the code, and then use the /fix command in the chat window to get the same results.

=========== END OF LAB ===========

Lab 3 - Using Copilot after the coding

Purpose: In this lab, we’ll see a few other ways to leverage Copilot after the initial coding is done

  1. Now that we have some code to work with, let's see what else Copilot can do for us. Let's have it explain the current code in our prime.py file. Select the code. Then, use the Cmd+I keys to bring up the Copilot interactive chat dialog.

Interactively telling Copilot to explain code

  1. Tell Copilot to explain the code by typing the command below in the dialog. (Note, the actual word may not show up after you type.) Hit Enter. Then, you should see the output in the chat window.
/explain

Output of interactively telling Copilot to explain code

  1. Now, let's do the same request but through a comment. In the prime.py file, below the code, enter the following comment and hit Enter.
# explain the code above line-by-line
  1. After this, Copilot should start showing the explanation in comments. Just hit tab to accept each line and then Enter to move to the next one.

Output of telling Copilot to explain code via comment

  1. We can also query Copilot inline via asking a question in a comment. Delete the commented explanation and try out the question below. To be clear you can prefix it with :q but that is not required with the chat feature installed.
# q: what does the function above do?

Prompting for what code does with q:

  1. Finally, let's see how to use the doc feature to automatically document our code. Highlight the actual code.

  2. Now, enter Cmd+I and enter the /doc command. After a few moments, Copilot should generate some documentation for the code. Do not Accept or Discard yet.

Generated doc for the code

  1. Let's see what other doc could be generated. Click on the circular arrow button next to Discard at the bottom of the dialog and click on it to regenerate another possible doc.

Regenerating doc

  1. Once you find a doc example you like, go ahead and click Accept.

  2. What else can we do in the chat panel?

If it is not already visible, open the GitHub Copilot Chat panel. Click on the icon for the GitHub Copilot Chat extension in the side panel.

Output of /help

Let's see if we can use chat to learn more about Copilot's capabilities. Enter the following in the chat panel and press Enter.

/help

Output of /help

As you can see in the output there are a growing number of Participants and Variables that you can use in GitHub Copilot Chat. For example, review the output to answer these questions:

  • Which Participant would you use to get the meaning of the selected lines in the terminal?
  • Which Variable would you use to feed a specific file to GitHub Copilot Chat as context, even though that file may not be in an open editor at the moment?

=========== END OF LAB ===========

Lab 4 - Using Copilot to generate tests

Purpose: In this lab, we'll see some examples of having Copilot generate tests

  1. Start out in the prime.py file we've been using. Position the cursor below the code.

  2. Enter a comment to create unit tests

# create a function to do 5 unit tests of the code above
  1. If you don't get a suggestion, enter code below to start nudging. Otherwise you can just accept the suggestion.
def test_is_prime():

generating tests via comment

  1. Let's try a slightly different way of generating tests. First, highlight and delete any parts of the current test function, including comments.

  2. Let's have chat generate the tests. Go ahead and highlight/delete any existing ones and the test function in the prime.py file.

  3. Select the set of code for is_prime. Then Go to chat and tell it to generate tests

/tests

Tests-generated tests

  1. We could put this into a new file by hovering over the output in the Chat window, then selecting the "..." from the pop-up menu and selecting "Insert into new file". Go ahead and select that option and then you'll have a new file in your editor with the code that you can save as needed.

Insert tests into new file

Saved generated unit tests file

=========== END OF LAB ===========

Lab 5 - Using Copilot to help with SQL

Purpose: In this lab, we’ll see some examples of how to have Copilot help with writing SQL

  1. Create a new file named dev.sql. You can create it via entering the line below in the terminal.
code dev.sql
  1. Afterwards this file should be open in a tab in the editor. Assume we want to work with a database or database definition that defines a dataset for students, staff, curriculums, courses, schools of study, locations, and registrations for a university system. Let's see what Copilot would generate without any other context for a query to get all students in a course. Enter the following comment below and press Tab to accept suggestions. Remember that you may have to hit Enter multiple times to get Copilot to prompt. Or if you don't get a suggestion or only get a comment, try "nudging" Copilot via typing "select".
-- define a select statement to get all students enrolled in a course
  1. Go ahead and save this file as part of the project. You can do this from the "3-line" menu under File->Save, or just click on the X next to the file's name in it's tab and select to Save it.

Save sql file

  1. If the file is no longer open in the tabs, you can select the "Explorer" icon at the top of the sidebar and select the file in the list to open it back up.

Reopening the file

  1. Let's see if we get any different results if we provide Copilot additional context. Open the file create-tables.sql in the editor from the GitHub repository. (You can either select and open it from the file list or use the command below from the terminal.) Scroll through it and take a quick look at the contents.
code create-tables.sql
  1. Now with that file open, go back up to the top of the dev.sql file. Highlight and delete the comment and resulting query from step 2.

  2. Enter the same comment as before to request the query. (Basically, repeat step 2.) See what Copilot suggests this time. You can accept the suggestions or cycle through options.

-- define a select statement to get all students enrolled in a course
  1. If all goes well, this second pass should generate a query with many more specific references to the names and identifiers used in create-tables.sql. (If not, delete the result and try again.) Take a look at the query and then compare the names/identifiers used to the ones in the create-tables.sql file. This will show that Copilot picks up on context from other files available to it to make better suggestions. This is one of the key principles of Prompt Engineering - providing the right context to Copilot to get the best results. Remember that Copilot is context-aware and will provide better results with more context. Take some time now to learn more about Prompt Engineering, check out Prompt engineering for GitHub Copilot from the GitHub documentation.

New query

  1. In some cases, we might be able to use a separate index to speed up operations. Let's ask Copilot to create a new index based on the last query. Add the following line after the current query in the file dev.sql.
-- write an index to improve the performance of the query

index

  1. Let's suppose we also want to have a table to capture student attendance. We can ask Copilot to create the table definition for us.
-- define a table for student attendance to capture attendance by class

(Here again, if you don't get a meaningful response from Copilot, you may need to nudge it by typing CREATE.) In the definition Copilot provided, it may have added a comment for the status in the same format as the comment in the courses.registration table definition in the create-tables.sql file.

status values

  1. Copilot can also create stored procedures. Let's ask it to create a new stored procedure for getting a list of enrolled students at a particular location. Let's use the CMD+I shortcut. Go to the bottom of the dev.sql file, invoke Copilot Chat via the shortcut and then enter the line below in the dialog. You can choose to Accept or Discard the result.
define a stored procedure to get course enrollment by location

prompt for stored procedure

  1. We can be more prescriptive with our stored procedure definition. Let's add a more complex request. Go to the Chat interface extension via clicking on the icon on the tool bar (if its not already opened). In the Chat window, enter the prompt below.
define a stored procedure to get instructor details associated with a location
include instructor details, location details, and courses associated with the instructor
use instructor_id as the input parameter

More extensive stored procedure definition

  1. Finally, let's see Copilot optimize a query for us. Suppose we want to get all the course registrations for September, 2023. Enter the following query in the file.
select * from courses.registration where year(registration_date) = 2023 and month(registration_date) = 9
  1. Ask Copilot to optimize the previous query. You can do this via highlighting the query, using the CMD+I shortcut and entering "/optimize" in the dialog. You can Accept or Discard the suggested optimization after that.
optimize

Optimizing a query

=========== END OF LAB ===========

Lab 6 - Teaching Copilot about updates

Purpose: In this lab, we’ll see an example of what to do when Copilot does not have the most up-to-date information

  1. Create a new file called explore.go via the same approach as you used to create other files.

  2. This file should now be open in an editor tab. Let's say we want to seed a random number generator with Go. Let's ask Copilot to write a function to do that. Prompt it through the CMD+I interface using the statement below. Then you can accept the suggested code.

write a function to seed a random number generator

Asking Copilot to write function to seed a random number generator

  1. Copilot has probably generated code using the rand.Seed function. The challenge is that as of Go 1.20, the Seed function is deprecated. Ref: https://cs.opensource.google/go/go/+/refs/tags/go1.21.0:src/math/rand/rand.go;l=394

  2. Let's see if Copilot understands that this is deprecated. We'll ask it via a query. Use CMD+I and the query below.

Is the Seed function deprecated in Go?
  1. Copilot probably responded with no and some info about the function. So one way we can help Copilot understand language updates is by providing the context in our file. So let's start again. Delete the current content in the explore.go file.

  2. Now, let's provide Copilot some more direct context by copying in updated code examples. After deleting the code block from step 3, copy and paste in the following example of the replacement for the Seed deprecation into your explore.go file. This is taken from pkg.go.dev/math/rand.

	// Create and seed the generator.
	// Typically a non-fixed seed should be used, such as time.Now().UnixNano().
	// Using a fixed seed will produce the same output on every run.
	r := rand.New(rand.NewSource(99))
  1. Now, let's try the creation of the function again. Underneath the comments and code you just pasted, invoke the dialog via CMD+I and enter the statement below again.
write a function to seed a random number generator
  1. This time, the code should be using the same format and NewSource function as you put in the file in step 6. You can just Accept the change.

Updated random number gen code after including updated usage

=========== END OF LAB ===========

Lab 7 - Kubernetes, YAML generation and the 2021 problem

Purpose: Show YAML generation and out of date content.

  1. Create a new file - deployment.yaml
code deployment.yaml
  1. Bring up the Copilot Chat dialog via CMD+I and enter in the following request.
write spec for deployment in Kubernetes with 2 replicas and image from busybox
add command to run in containers: sleep 3600
add label app: myapp
add label type: front-end
  1. After a few moments, you should see it respond with the code. You can just Accept this. Kubernetes manifest

  2. Suppose we don't know how to execute this code. Let's ask Copilot. Highlight the generated YAML in the deployment.yaml file. Then go to the larger Chat interface and ask it. Put the following in the Chat interface.

How do I execute this - short version?
  1. Copilot should respond with something like the following:

How to execute deployment

  1. While we're in the Chat interface, let's ask it for the latest K8s version. Put the following into the dialog.
what is the latest Kubernetes version?
  1. Notice that it identifies the latest version as 1.22 as of September 2021. This highlights the out-of-date issue with the LLM.

Answer to latest K8s version

  1. Let's have Copilot generate some code to work with Kubernetes through the API. In the chat interface, enter the following.
How do I call the K8s API for scaling a deployment to 5 replicas with Python?
  1. Click in chat output and paste to new file via clicking on the "..." menu option.

Add code to new file

  1. Suppose we change our mind and want to convert this code to Go. Click in the new file, and highlight the new code. Then, in the Chat interface tell it to translate to Go.
translate to Go 
  1. If you look at the output from the Chat interface, you should now have the equivalent Go code available.

Go translation

=========== END OF LAB ===========

Lab 8 - Exploring JavaScript, regular expression generator, auto-generating data

Purpose: Show JavaScript and regular expression generation, auto-generate routine mappings

  1. Create a new file as phone.js
code phone.js
  1. Prompt Copilot to create a function with a regular expression to validate a US phone number. You can use the CMD+I interface.
create a function to validate any global phone number using a regular expression

Regex function to validate phone #

  1. Let's tell it to document the function by highlighting the code, invoking CMD+I and /doc. You can just Accept the results.

Automatic doc of function

  1. Now let's see how Copilot can generate some data and mappings for us automatically. Enter the prompt below in the main Chat text entry area.
create a mapping of states to area codes
the key is the state abbreviation
the value is an array of area codes with max 5
  1. After running this, Copilot will generate the start of a list as shown below. Hover over the output area and click to insert the updates at the cursor in the phone.js file. (This assumes the cursor is below the previous function in the file.)

Automatic gen of data

  1. Notice that the example mapping was only for the first few states. We want to get the remaining mappings for the other states.

Partial list of mappings

  1. Let's craft a prompt to complete the sequence. Enter the following in the main Copilot Chat entry box and then execute it.
create a mapping of the remaining states to area codes 
the key is the state abbreviation
the value is an array of area codes with max 5

Completing the mappings

  1. From the generated text in the chat, if the results look ok, you can copy the mappings and add them into the code file. But, if not, you may have to give a better prompt. You can try highlighting the current mappings and use a prompt like the one shown below. (Note that the chat shows that it only used the lines highlighted as a reference.)
create a mapping of the next 25 states to area codes in the same format where
the key is the state abbreviation
the value is an array of area codes

Better prompt for remaining mappings

Copying remaining mappings

=========== END OF LAB ===========

Lab 9 - Agents and CLI

Purpose: In this lab, we'll get some practice using GitHub Copilot agents and the Copilot CLI.

  1. Let's go ahead and invoke the @terminal agent to ask a common question about how to commit code changes. Go to the chat interface and enter the prompt below. Afterwards, the commands to do the commit should show up in the chat window as shown below.
@terminal how do I commit my code changes?

querying for commit query output

  1. Hover over the window with the commands in it, and then click on the icon that pops up for the terminal. Click on that to insert it into the terminal. You don't have to commit the changes right now.

insert into terminal

  1. Now let's see how Copilot can help with generating commit messages. Click on the source control extension icon in the left sidebar. If you don't have any files showing up as eligible for commit, try closing some of the open files you have in the codespace by clicking on the "x" in the tab. With some files showing up to commit, click on the sparkle icon (in the upper right of the commit message box) to have Copilot generate a commit message. If you don't like the message it generates, you can click on the same icon again to see another option. You can commit the changes if you want, but its not necessary.

copilot generating commit messages

  1. Now, let's use the @workspace agent to help identify how we can test our code. In the chat text area, enter the following prompt:
@workspace what do I use to test my prime number code?
  1. After executing this, you'll have some suggested information on how to test the code in your workspace.

  2. Finally, let's work with the Copilot command line interface. The codespace already has the GitHub CLI installed, so we just need to install the Copilot extension and authenticate. Enter the following in the terminal.

gh extension install github/gh-copilot
  1. After this, you can invoke the copilot command line to see the options available.
gh copilot

Copilot CLI help

  1. To authenticate, use the command below in the terminal.
gh auth login --web
  1. Follow the prompts. You'll get a one-time activation code that you should copy and then paste in the browser when prompted. (If you happen to get a message about an issue with GITHUB_TOKEN, you can use the command export GITHUB_TOKEN= to clear that.) You'll need to click on the "Authorize" button on the next screen after this to complete the process.

Copilot CLI auth

  1. Once you have authenticate, you can try a couple of gh copilot commands like the ones below to see an example of how the CLI works.
gh copilot explain "ps -aux"
gh copilot suggest "install terraform"

=========== END OF LAB ===========

Lab 10 - Stay in the flow with GitHub Copilot

Purpose: In this lab, we'll show how you can use GitHub Copilot Chat to get answers to programming related questions without leaving your editor.

  1. Use the chat interface to ask a question about a programming topic. For example, you can ask about the latest version of a programming language, how to use a specific function, or how to solve a specific problem. Enter the question below in the chat interface.
What is the latest LTS version of Node.js?

Use Copilot to ask programming questions

The response is based on the information available to Copilot at the time the models were trained. As of June 2024, there is a new preview feature: GitHub Copilot can now search Bing within chat conversations in VS Code to answer questions and find information outside of its general knowledge or your codebase. To get answers enriched with Bing search results, start your message with @github. Copilot will intelligently decide when to use Bing.

  1. Let's try using @github to get an answer based on a Bing search. Enter the question below in the chat interface.
@github What is the latest LTS version of Node.js?

Use Bing with Copilot to ask programming questions

This response is enriched with Bing search results. You can use this feature to get answers to questions that are not covered by Copilot's general knowledge or your codebase.

  1. Let's see if we can use @github to learn about the advantages of using GitHub Copilot. Enter the question below in the chat interface.
@github Why is GitHub Copilot better and more secure to use than prompting ChatGPT and copy/pasting the code back into my IDE?

Does the response help you understand why GitHub Copilot is better and more secure to use than prompting ChatGPT and copy/pasting the code back into your IDE?

  1. Learn how to get started with the Azure OpenAI Service

You can leverage the Azure OpenAI Service to build your own copilot and generative AI applications. But, how do you get started? Let's ask GitHub Copilot. Enter the question below in the chat interface, be sure to replace [language X] with the language you are most likely to use, e.g. JavaScript or, Python or, Java, etc.

@github We use [language X] for application development. How would I get started with Azure OpenAI?

Visual for step 1

This provides a wealth of information. To save the response, right-click anywhere in the response and select Copy. Now you can paste the response somewhere that you can reference later such as a GitHub Issue or, a GitHub Discussion post.

  1. While we can use @github to get answers to programming questions, we cannot use GitHub Copilot Chat to ask general questions. For example, you cannot ask about the weather or the latest sports scores. Enter the question below in the chat interface.
@github Who won the Super Bowl in 1986?

GitHub Copilot is only for programming

That's ok. Everyone knows that the Chicago Bears won Super Bowl XX in 1986. 😉

Chicago Bears win Super Bowl XX

=========== END OF LAB ===========

Lab 11 - Being specific in your prompts

Purpose: In this lab, we'll start with a simple command and then add more and more specificity and see how that impacts the suggestions we receive.

  1. The context for this exercise is that we want to create a GitHub Actions workflow to build a .NET Core application and deploy it to Azure Web Apps. This will also demonstrate that GitHub Copilot goes beyond traditional programming and can help you with many other things like CI/CD workflow files. Enter the prompt below in the chat interface.
Create a GitHub Actions workflow to build a .NET Core application and deploy it to Azure Web Apps.

Generate a GitHub Actions Workflow

Take some time to analyze the resulting GitHub Actions workflow. You can see that it is referencing several Actions that come from the GitHub Marketplace, what a time saver! We did not have to manually figure out and look up the multiple Actions that need to be used, GitHub Copilot did that for us. Your suggestion may include an important note insturucting you to properly manage the AZURE_WEBAPP_PUBLISH_PROFILE. This is a form of a secret that we would want manage very diligently to ensure that it does not fall into the hands of a hacker. We can use Azure OpenID Connect to avoid having to manage and store secrets like an AZURE_WEBAPP_PUBLISH_PROFILE.

  1. Let's refine the prompt to be more specific and see what happens. Enter the refined prompt below in the chat interface.
Create a GitHub Actions workflow to build a .NET Core application and deploy it to Azure Web Apps.
Use "OpenID Connect" to authenticate with Azure.

Generate a GitHub Actions Workflow

There may now be a Login to Azure step that is needed to work with Azure OpenID Connect. Also, the important notes will refer to AZURE_CLIENT_ID, AZURE_TENANT_ID, and AZURE_SUBSCRIPTION_ID. These are just identifiers for your specific Azure environment and not a form of a secret that a hacker could use to access and change your web app. By adding more specifics to our prompt, we've made our deployment more secure.

  1. This is a great start but, you should also include quality checks in your CI/CD workflow like running automated tests, load tests, etc. We can use the Playwright testing framework and Azure Load Testing for this. Let's add some more specifics to the prompt. Enter the refined prompt below in the chat interface.
Create a GitHub Actions workflow to build a .NET Core application and deploy it to Azure Web Apps. 
Use "OpenID Connect" to authenticate with Azure. 
After the app is deployed run a set of functional tests using the Playwright framework
then, run a set of load tests using Azure Load Tests.

Take a look at the new workflow and related notes. By adding more and more specifics to our prompt we were able to get a more comprehensive GitHub Actions workflow and, we did not have to break our flow, leave the IDE and go to the GitHub Marketplace to figure out which Actions to use.

Now that we have this workflow, we can ask GitHub Copilot to insert the suggested workflow into a new file in our workspace. To do this you would hover over the top of the suggestion, click on the ... and select Insert into New File. You may also want to copy the related notes from that chat window and paste those into your planning and tracking tool (e.g. GitHub Issues and Projects, Jira, Azure Boards, etc.).

Generate a GitHub Actions Workflow

The key takeaways from this lab are that you can iterate via GitHub Copilot Chat by adding more and more specifics to end up with a very comprehensive suggestion. So, as you are crafting prompts be sure to think about what specifics you should add to help ensure that GitHub Copilot provides suggestions that meet all of your requirements for scalability, maintainability, robustness, etc. Also, GitHub Copilot can be used to generate a lot more than just traditional "code". Where else might you want to leverage GitHub Copilot? Creating Infrastructure as Code files such as Terraform files? Writing PowerShell scripts? GitHub Copilot is your AI Pair Programmer for just about anything.

=========== END OF LAB ===========

Wrap up and next steps

GitHub Copilot can be used with almost any language! As you have seen in this lab, you can use GitHub Copilot to generate code in almost any language. You can also use it to generate Markdown. GitHub Copilot was used to generate the content of this lab guide.

Check out these resources to dive in and learn more

If you have completed all the labs, and there is still time left in today's session you can check out the resources in GitHub-Copilot-Resources.md.

This resource list has been carefully curated to help you to learn more about GitHub Copilot, how to use it effectively, what is coming in the future, what are GitHub customers saying and more. There is even a YouTube playlist that includes the latest videos from the GitHub Developer Relations team and others from GitHub.

Add https://github.com/DaveOps30/copilot-hands-on/blob/main/GitHub-Copilot-Resources.md to your browser favorites for easy access to these resources at any time in the future.

Looking to learn more? Check out "Microsoft Learn"

Microsoft Learn has a plethora of learning paths. If you still have time in this session and/or you want to continue learning more about GitHub Copilot, check out the GitHub Copilot Fundamentals - Understand the AI pair programmer learning path. Here are a few modules that serve as great follow ups to this lab:

  • Introduction to prompt engineering with GitHub Copilot - Discover the essentials of creating effective prompts with GitHub Copilot. Uncover techniques to transform your coding comments into precise, actionable code, enhancing your development workflow. (26 min)
  • Introduction to GitHub Copilot for Business - Learn about the difference between GitHub Copilot for Business versus GitHub Copilot for Individuals, specific use cases and customer stories for GitHub Copilot for Business, and how to enable it. (23 min)
  • Introduction to GitHub Copilot Enterprise - Learn about the differences between GitHub Copilot for Enterprise, for Business, and for Individuals. Examine specific use cases, including how to enable and use GitHub Copilot Enterprise. (17 min)

Book mark https://learn.microsoft.com/ so that you can explore other Learning Paths in the future such as Develop Generative AI solutions with Azure OpenAI Service

Please let us know what you think of GitHub Copilot and this workshop

We would love to hear your thoughts on GitHub Copilot and this workshop.

  • Please take a moment to answer the poll questions in the Workshop Survey.
    • For each of the two questions, simply select your response and click the "Vote" button.
    • Please feel free to leave a comment to let us know what you really liked and/or what we could do differently to make this workshop more valuable in the future.
  • If you have any feedback or suggestions for improvement, please let us know in the Workshop Feedback & Suggestions discussion category.

**THANKS!**