docs(exercise-3): fix hint anchors + add marketplace-actions guide#7
Open
ShmuelMax100 wants to merge 2 commits intomainfrom
Open
docs(exercise-3): fix hint anchors + add marketplace-actions guide#7ShmuelMax100 wants to merge 2 commits intomainfrom
ShmuelMax100 wants to merge 2 commits intomainfrom
Conversation
- Re-point all 10 'Read this' links from section headers to the exact code lines - Add modules/02-github-actions/marketplace-actions.md covering Marketplace discovery, evaluation, safe usage, and the publish-release example - Wire TODO 10 hint to the new marketplace-actions.md publish-release example - Link the new guide from README Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…actions.md Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR updates the GitHub Actions training materials for Exercise 3 by tightening hint links to exact source lines and adding a new guide for safely using Marketplace actions. It fits into the workshop docs by improving the discoverability and accuracy of learning references in Module 2.
Changes:
- Added a new
marketplace-actions.mdguide covering action discovery, evaluation, SHA pinning, permissions, and a release example. - Updated Exercise 3 hint links to point at exact YAML lines instead of broader section headers.
- Added the new Marketplace-actions guide to the Module 2 README index, and included an additional presentation image asset.
Reviewed changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
resources/presentation/github-pr-ui.png |
Adds a new presentation image asset. |
modules/02-github-actions/marketplace-actions.md |
New guide for finding, evaluating, and safely using Marketplace actions. |
modules/02-github-actions/exercises/exercise-3.md |
Retargets Exercise 3 hint links to more precise line anchors and updates TODO ⑩ guidance. |
README.md |
Adds the new Marketplace-actions guide to the Module 2 topic list. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+74
to
+77
| tag_name: ${{ inputs.version }} | ||
| name: Release ${{ inputs.version }} | ||
| generate_release_notes: true # auto-generate from PR titles | ||
| prerelease: ${{ inputs.prerelease }} # honor the dispatch input |
| | ⑦ | `workflow_dispatch` inputs | Manual triggers | [manual-triggers.md → `workflow_dispatch:` snippet](../manual-triggers.md?plain=1#L23) | | ||
| | ⑧ | `jobs.<id>.uses:` | Calling a reusable workflow | [reusable-workflows.md → `uses: ./.github/workflows/deploy.yml` line](../reusable-workflows.md?plain=1#L75) | | ||
| | ⑨ | Reusing the composite action | DRY principle | [reusable-workflows.md → `uses: ./.github/actions/...` line](../reusable-workflows.md?plain=1#L150) | | ||
| | ⑩ | Third-party action via SHA-pinned `uses:` | Marketplace actions | [marketplace-actions.md → `Create GitHub Release` step (copy this block)](../marketplace-actions.md?plain=1#L71) · [security-best-practices.md → SHA-pin example](../security-best-practices.md?plain=1#L16) | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Two fixes to Exercise 3 (Release Pipeline) feedback:
1. Hint links now point at exact code lines, not section headers
Every TODO's
Read thislink was landing on a section heading rather than on the YAML snippet that answers the TODO. Re-pointed all 10 to the exact line of the relevant code:runs:block)inputs.python-versionuse)on: workflow_call:)fromJSON(inputs.python-versions))uses: ./.github/actions/...)workflow_dispatch:snippet)uses: ./.github/workflows/deploy.yml)uses: ./.github/actions/...)marketplace-actions.md#L54+ SHA-pin link2. TODO ⑩ now has a real reference
TODO ⑩ asks the learner to "Create a GitHub Release using a third-party action", but no module guide showed that pattern. The hint pointed only at SHA-pinning advice. Added a new guide:
modules/02-github-actions/marketplace-actions.mdCovers:
permissions:)softprops/action-gh-releasepublish-release example matching what TODO ⑩ asks forLinked from the README's Module 2 table.
Why
User feedback: "hints and solutions are not pointing exactly to the lines where the needed code for TODO. or sometimes the needed code is not in the hint at all."
Test
?plain=1#L<n>anchors verified against current target-file line numbersmarketplace-actions.mdline 54 lands on "## Example: publish a GitHub Release"Out of scope
The
os-list/quickmismatch between the exercise template andsolutions/03-release-workflow/(separately tracked) is not addressed in this PR.