github-samples / github-samples/pets-workshop
full-day workshop: Correct the CI workflow triggers and first-run verification
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 80
- Forks
- 161
- Avg merge
- 31m
- Merged PRs (30d)
- 1
Description
Problem
content/full-day/4-testing.md describes merge as a GitHub Actions event, but there is no merge workflow event; a merge to main is normally handled as a push. Learners are also told to request an on-demand trigger, while the example omits workflow_dispatch.
The example restricts both push and pull_request to app/server/**. The first commit adds only .github/workflows/server-test.yml, so the text's claim that this push triggers the workflow is false: the path filter prevents that first run. Learners can reach the Actions page with no run to inspect.
Suggested change
Teach the actual event semantics and provide an example whose triggers support every verification step in the exercise.
Acceptance criteria
-
mergeis removed as an event name and explained as a push to the target branch. - The example includes
workflow_dispatchwhen on-demand execution is required. - Adding or changing the workflow itself triggers a run, or learners are explicitly told to dispatch it manually.
- Server changes still trigger push and pull-request runs.
- The exact first-run flow is tested in a fresh template repository.
Related: #236 separately tracks the pytest/unittest inconsistency.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with content/full-day/4-testing.md and compare its trigger explanations with .github/workflows/server-test.yml. Verify the first-run flow in a fresh template repository, including workflow changes, server changes, pull requests, and on-demand execution. Done means the documented events and verification steps match the observed GitHub Actions runs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions
- Domain
- ci-cd, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 76/100