Skip to content

Commit c76bef2

Browse files
authored
Merge pull request #11 from githubuniverseworkshops/part3-branch
Add part 3 bonus and more resources
2 parents ee1bc52 + 2d84ce6 commit c76bef2

File tree

1 file changed

+55
-5
lines changed

1 file changed

+55
-5
lines changed

workshop/README.md

Lines changed: 55 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,7 @@ Progress: [🟢🟢⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪] 2/12 (16%)
5757
cd <YOUR_REPO_NAME>
5858
```
5959

60-
> [!NOTE]
61-
> There is no need to push changes back to the repo during the workshop
60+
> 📝 **Note:** There is no need to push changes back to the repo during the workshop
6261

6362
### 3. Verify Python is installed and set correctly
6463

@@ -366,7 +365,7 @@ There are a couple of bonus challenges if you've completed all the tasks and you
366365
### Bonus Challenge 1 - Create a robust CLI tool
367366
368367
Progress: [🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢] 12/12 (100%) 🎉
369-
Optional: [🚀 Turbo Boost! (1/2) 50%]
368+
Optional: [🚀 Turbo Boost! (1/2) 33%]
370369
371370
- Use GitHub Copilot chat with the `@workspace` prefix to convert the project into a CLI with options and a help menu
372371
- Ensure that the prompt specifies no external dependencies and it should only use the standard library
@@ -423,8 +422,8 @@ if __name__ == "__main__":
423422
### Bonus Challenge 2 - Document your project
424423
425424
Progress: [🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢] 12/12 (100%) 🎉
426-
Optional: [🚀 Turbo Boost! (1/2) 50%]
427-
Optional: [🌟 Extra Points! (2/2) 100% 🏆]
425+
Optional: [🚀 Turbo Boost! (1/2) 33%]
426+
Optional: [🌟 Extra Points! (2/2) 66%]
428427
429428
- Create a new `docs/` folder and a file called `README.md`
430429
- Use GitHub Copilot chat with the `@workspace` prefix to get started documenting your project using Markdown in a README.md
@@ -541,6 +540,47 @@ This project is licensed under the MIT License. See the [LICENSE](../LICENSE) fi
541540
542541
</details>
543542
543+
### Bonus Challenge 3 - Automate the data transformation
544+
545+
Progress: [🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢🟢] 12/12 (100%) 🎉
546+
Optional: [🚀 Turbo Boost! (1/2) 33%]
547+
Optional: [🌟 Extra Points! (2/2) 66%]
548+
Optional: [🏆 Triple Threat! (2/2) 100%]
549+
550+
- Create a new file called `transform-data.yaml` in the `.github/workflows/` directory.
551+
- Use GitHub Copilot chat with the `@workspace` prefix to create a GitHub Action that will transform the data whenever a push or pull request is made to the repository.
552+
- Open a pull request to test the action. If any errors occur, use the GitHub Copilot chat to help you fix them.
553+
554+
<details>
555+
<summary>Cheatsheet</summary>
556+
557+
#### Prompt
558+
559+
```shell
560+
@workspace Generate a GitHub action that transforms the data on every push and pull request
561+
```
562+
563+
#### Expected output
564+
565+
```markdown
566+
To create a GitHub Action that will transform the data using your CLI, you can create a workflow file in the `.github/workflows` directory. Here is an example of a GitHub Action workflow file named `transform-data.yml`:
567+
568+
```yaml
569+
// Workflow omitted, since this is the final bonus!
570+
```
571+
572+
This workflow will:
573+
574+
* Trigger on pushes to the main branch and on manual dispatch.
575+
* Check out the repository.
576+
* Set up Python.
577+
* Install the necessary dependencies (in this case, pandas).
578+
* Run the data transformation using the `run_all` command from your CLI.
579+
* Upload the transformed data as an artifact.
580+
```
581+
582+
</details>
583+
544584
## Clean-up
545585
546586
### 1. Delete your Codespace
@@ -550,3 +590,13 @@ This project is licensed under the MIT License. See the [LICENSE](../LICENSE) fi
550590
Before deleting, if you wish, you can push your changes. Remember workshop repositories are temporary too.
551591
552592
Go to [https://github.com/codespaces](https://github.com/codespaces) and find your current running Codespace and delete it.
593+
594+
## Additional resources
595+
596+
If you want to learn more about using GitHub Copilot, check out these resources:
597+
598+
* [GitHub Copilot Documentation](https://docs.github.com/copilot)
599+
* [VS Code video series: GitHub Copilot](https://www.youtube.com/playlist?list=PLj6YeMhvp2S7rQaCLRrMnzRdkNdKnMVwg)
600+
* [Blog: Best practices for prompting Copilot](http://blog.pamelafox.org/2023/06/best-practices-for-prompting-github.html)
601+
602+
Also check out the [GitHub Foundations learning path](https://learn.microsoft.com/training/paths/github-foundations/) for more resources on GitHub and GitHub Copilot.

0 commit comments

Comments
 (0)