docs: harmonize examples 'use: ./' syntax explanation#1534
Merged
jennifer-shehane merged 4 commits intoSep 3, 2025
Conversation
Collaborator
|
jennifer-shehane
requested changes
Sep 2, 2025
Collaborator
Author
|
I made your suggested style change through a global edit as the debug workflow was the original text I copied from and that wasn't visible in the PR. |
jennifer-shehane
approved these changes
Sep 3, 2025
|
🎉 This PR is included in version 6.10.3 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
Situation
Example workflows, such as .github/workflows/example-basic.yml include the syntax
uses: ./to run the action from the root of the repo's current branch. This is not explained in the README and the comments in the different example workflows in the .github/workflows are inconsistently worded. Some workflows don't contain any related remark.Change
uses: ./For workflows with multiple calls to the action, add a comment at the top of the workflow to avoid replicating the comment on multiple lines: