Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
## Changes
<!-- Provide a brief description of the changes introduced by this PR -->

## Checklist
<!-- Mark the items with an "x" once completed -->
- [ ] I have added or updated appropriate labels to this PR
- [ ] I have tested my changes
- [ ] I have updated the documentation if needed
3 changes: 0 additions & 3 deletions CONTRIBUTING.md

This file was deleted.

78 changes: 75 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,83 @@

This repository serves as a comprehensive toolkit for creating and managing GitHub Skills exercises. It provides a collection of tools, templates, and utilities designed to streamline the process of developing educational content for GitHub Skills.

## Contents
### Contents

- **[.github/workflows](/.github/workflows)**: GitHub Actions workflows for automating common parts of Skills Exercises
- **[markdown-templates](/markdown-templates)**: Ready-to-use Markdown templates for creating consistent exercise documentation, instructions, and README files

## Contributing
## Examples

For contribution guidelines, see our [CONTRIBUTING.md](/CONTRIBUTING.md) file.
### ⚙️ Reusable Workflows

For a full list of reusable workflows go to the **[.github/workflows](/.github/workflows)** directory.

#### Starting an exercise

```yaml
jobs:
start_exercise:
name: Start Exercise
uses: skills/exercise-toolkit/.github/workflows/start-exercise.yml@<git-tag>
with:
exercise-title: "Introduction to GitHub Copilot"
intro-message: "Let's get you started with GitHub Copilot :robot: ! We will learn ..."

```

#### Finding an exercise

```yaml

jobs:
find_exercise:
name: Find Exercise Issue
uses: skills/exercise-toolkit/.github/workflows/find-exercise-issue.yml@<git-tag>

```


### 📋 Markdown Templates

For a full list of markdown templates go to the **[markdown-templates](/markdown-templates)** directory.

```yaml
steps:
- name: Get markdown templates
uses: actions/checkout@v4
with:
repository: skills/exercise-toolkit
path: exercise-toolkit
ref: <git-tag>

- name: Use the template
run: |
cat exercise-toolkit/markdown-templates/step-feedback/checking-work.md

```

Markdown templates are often used together with [skills/action-text-variables](https://github.com/skills/action-text-variables) GitHub Action

```yaml
steps:
- name: Get markdown templates
uses: actions/checkout@v4
with:
repository: skills/exercise-toolkit
path: exercise-toolkit
ref: <git-tag>

- name: Build message - congratulations
id: build-message-congratulations
uses: skills/action-text-variables@v1
with:
template-file: exercise-toolkit/markdown-templates/readme/congratulations.md
template-vars: |
login=${{ github.actor }}

- name: Echo updated text
run: echo "$UPDATED_TEXT"
env:
UPDATED_TEXT: ${{ steps.build-message-congratulations.outputs.updated-text }}

```