refactor: minimize main readme and use exercise toolkit for starting the exercise (#28)

Co-authored-by: Christopher W. Blake <[email protected]>

Author: FidelusAleksander

.github/workflows/0-start-exercise.yml

@@ -11,133 +11,25 @@ permissions:
   issues: write
 
 env:
-  EXERCISE_NAME: "Getting Started with GitHub Copilot"
-  INTRO_MESSAGE: "Welcome to the exciting world of GitHub Copilot! 🚀 In this exercise, you'll unlock the potential of this AI-powered coding assistant to accelerate your development process. Let's dive in and have some fun exploring the future of coding together! 💻✨"
   STEP_1_FILE: ".github/steps/1-preparing.md"
 
 jobs:
-  disable_workflows:
-    name: Disable workflows
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Disable all workflows
-        run: |
-          workflows=$(git ls-files | grep -E '\.yml$|\.yaml$')
-          for workflow in $workflows; do
-            workflow_name=$(basename $workflow)
-            gh workflow disable "$workflow_name" || true
-          done
-        env:
-          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
   start_exercise:
     if: |
       !github.event.repository.is_template
     name: Start Exercise
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Configure Git user
-        run: |
-          git config user.name github-actions[bot]
-          git config user.email github-actions[bot]@users.noreply.github.com
-
-      - name: Deactivate 'Start Excercise' button
-        run: |
-          # Remove href from 'Start Exercise' button
-          target='id="copy-exercise"[^>]*href="[^"]*"'
-          replacement='id="copy-exercise"'
-          sed -i "s|$target|$replacement|g" README.md
-
-          # Change color from green to gray
-          target=Copy_Exercise-008000
-          replacement=Copy_Exercise-AAA
-          sed -i "s|$target|$replacement|g" README.md
-
-      - name: Activate 'Start Exercise' button
-        run: |
-          # Add link to issue
-          target='id="start-exercise"'
-          replacement='id="start-exercise" href="../../issues/1"'
-          sed -i "s|$target|$replacement|g" README.md
-
-          # Change color from gray to green
-          target=Start_Exercise-AAA
-          replacement=Start_Exercise-008000
-          sed -i "s|$target|$replacement|g" README.md
-
-      - name: Replace relative links in readme
-        run: |
-          target=../../
-          replacement=https://github.com/${{ github.repository }}/
-          sed -i "s|$target|$replacement|g" README.md
-
-      - name: Push README changes
-        run: |
-          git add README.md
-          git commit --message="Start exercise"
-          git push
-        env:
-          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-  create_exercise:
-    if: |
-      !github.event.repository.is_template
-    name: Create exercise issue
-    runs-on: ubuntu-latest
-
-    outputs:
-      issue-url: ${{ steps.create-issue.outputs.ISSUE_URL }}
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Get response templates
-        uses: actions/checkout@v4
-        with:
-          repository: skills/response-templates
-          path: skills-response-templates
-
-      - name: Configure Git user
-        run: |
-          git config user.name github-actions[bot]
-          git config user.email github-actions[bot]@users.noreply.github.com
+    uses: skills/exercise-toolkit/.github/workflows/[email protected]
+    with:
+      exercise-title: "Getting Started with GitHub Copilot"
+      intro-message: "Welcome to the exciting world of GitHub Copilot! 🚀 In this exercise, you'll unlock the potential of this AI-powered coding assistant to accelerate your development process. Let's dive in and have some fun exploring the future of coding together! 💻✨"
 
-      - name: Build welcome message from template
-        id: build-issue-description
-        uses: skills/action-text-variables@v1
-        with:
-          template-file: skills-response-templates/step-feedback/welcome.md
-          template-vars: |
-            title=${{ env.EXERCISE_NAME }}
-            login=${{ github.actor }}
-            intro_message=${{ env.INTRO_MESSAGE }}
-
-      - name: Create issue - add welcome message
-        id: create-issue
-        run: |
-          issue_url=$(gh issue create \
-            --title "Exercise: $EXERCISE_NAME" \
-            --body "$ISSUE_BODY")
-          echo "ISSUE_URL=$issue_url" >> "$GITHUB_OUTPUT"
-        env:
-          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          ISSUE_BODY: ${{ steps.build-issue-description.outputs.updated-text }}
 
   post_next_step_content:
     name: Post next step content
     runs-on: ubuntu-latest
-    needs: [create_exercise]
+    needs: [start_exercise]
     env:
-      ISSUE_URL: ${{ needs.create_exercise.outputs.issue-url }}
+      ISSUE_URL: ${{ needs.start_exercise.outputs.issue-url }}
 
     steps:
       - name: Checkout

README.md

@@ -1,10 +1,5 @@
 # Getting Started with GitHub Copilot
 
-![](../../actions/workflows/1-preparing.yml/badge.svg)
-![](../../actions/workflows/2-first-introduction.yml/badge.svg)
-![](../../actions/workflows/3-copilot-edits.yml/badge.svg)
-![](../../actions/workflows/4-copilot-on-github.yml/badge.svg)
-
 _Get started using GitHub Copilot in less than an hour._
 
 ## Welcome
@@ -26,35 +21,23 @@ In this exercise, you will:
 
 ### How to start this exercise
 
-1. Right-click **Copy Exercise** and open the link in a new tab.
-
-   <a id="copy-exercise" href="https://github.com/new?template_owner=skills&template_name=getting-started-with-github-copilot&owner=%40me&name=skills-getting-started-with-github-copilot&description=Exercise:+Get+started+using+GitHub+Copilot&visibility=public">
-      <img src="https://img.shields.io/badge/📠_Copy_Exercise-008000" height="25pt"/>
-   </a>
-
-2. In the new tab, most of the fields will automatically fill in for you.
-
-   - For owner, choose your personal account or an organization to host the repository.
-   - We recommend creating a public repository, as private repositories will use [Actions minutes](https://docs.github.com/en/billing/managing-billing-for-github-actions/about-billing-for-github-actions).
-   - Scroll down and click the **Create repository** button at the bottom of the form.
+Simply copy the exercise to your account, then give your favorite Octocat (Mona) **about 20 seconds** to prepare the first lesson, then **refresh the page**.
 
-3. After your new repository is created, wait about 20 seconds for the exercise to be prepared and buttons updated. You will continue working from your copy of the exercise.
+[![](https://img.shields.io/badge/Copy%20Exercise-%E2%86%92-1f883d?style=for-the-badge&logo=github&labelColor=197935)](https://github.com/new?template_owner=skills&template_name=getting-started-with-github-copilot&owner=%40me&name=skills-getting-started-with-github-copilot&description=Exercise:+Get+started+using+GitHub+Copilot&visibility=public)
 
-   - The **Copy Exercise** button will deactivate, changing to gray.
-   - The **Start Exercise** button will activate, changing to green.
-   - You will likely need to refresh the page.
+<details>
+<summary>Having trouble? 🤷</summary><br/>
 
-4. Click **Start Exercise**. Follow the step-by-step instructions and feedback will be provided as you progress.
+When copying the exercise, we recommend the following settings:
 
-   <a id="start-exercise">
-      <img src="https://img.shields.io/badge/🚀_Start_Exercise-AAA" height="25pt"/>
-   </a>
+- For owner, choose your personal account or an organization to host the repository.
 
-> [!IMPORTANT]
-> The **Start Exercise** button will activate after copying the repository. You will probably need to refresh the page.
+- We recommend creating a public repository, since private repositories will use Actions minutes.
+   
+If the exercise isn't ready in 20 seconds, please check the [Actions](../../actions) tab.
 
----
+- Check to see if a job is running. Sometimes it simply takes a bit longer.
 
-Get help: [Post in our discussion board](https://github.com/orgs/skills/discussions/categories/getting-started-with-github-copilot) &bull; [Review the GitHub status page](https://www.githubstatus.com/)
+- If the page shows a failed job, please submit an issue. Nice, you found a bug! 🐛
 
-&copy; 2025 GitHub &bull; [Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md) &bull; [MIT License](https://gh.io/mit)
+</details>