| Jul | AUG | Sep |
| 29 | ||
| 2024 | 2025 | 2026 |
COLLECTED BY
Collection: Independent Media Afghanistan
.gitignore file. You can see an example .gitignore. We recommend at minimum ignoring operating system generated files.
●Include skills-course in the repository topics.
### :keyboard: Activity: Specific description
●Use an ordered list to briefly describe what the learner needs to do
●Let the learner know it will need about 20 seconds and refresh to move on to the next step
●Include warning and troubleshooting information if the learner gets stuck
Try to keep your formatting consistent so the learner can more easily find what they are looking for.
The first step is the hardest, so pick something easy! On the first step, encourage users to open new tabs for steps.
N-brief-summary.yml, where Nis the step number and brief-summary describes the step. We recommend this format to make it easy to see the order the steps will run in.
Each workflow file will have a few sections, the name, describing comments, event trigger, job header, and steps.
The first section is the name:
name: Step 0, Start
Next, add comments describing what the Actions workflow will do:
# This step triggers after the learner creates a new repository from the template.
# This step updates from step 1 to step 2.
Followed by the event trigger:
# This will run every time we create push a commit to `main`.
# Reference: https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows
on:
workflow_dispatch:
push:
branches:
- main
Next is the job header. You can add iftags to limit the scope of the event trigger here. You窶冤l also need to specify runs-on to get your Actions workflow running.
jobs:
on_start:
name: On start
# We will only run this action when:
# 1. This repository isn't the template repository.
# Reference https://docs.github.com/en/actions/learn-github-actions/contexts
# Reference https://docs.github.com/en/actions/learn-github-actions/expressions
if: ${{ !github.event.repository.is_template }}}
# We'll run Ubuntu for performance instead of Mac or Windows.
runs-on: ubuntu-latest
Last, we are finally in the steps of the Actions workflow. This is the heart of the file, where you can customize your course the most.
steps:
# We'll need to check out the repository so that we can edit the README.
- name: Checkout
uses: actions/checkout@v3
# Update README and set step to '1'.
- name: Update to step 1
uses: skills/action-update-step@v2
with:
token: ${{ secrets.GITHUB_TOKEN }}
from_step: 0
to_step: 1
branch_name: my-first-branch
You may include the update step action in your course,
however it is not fully required. You may also customize this script to meet the needs of your course.
Include thorough comments in your workflow files to describe each section. Other authors and your future self will thank you later.