docs: wrong syntax in Container action docs
Open
Nobody has claimed this yet.
bug
- Dominant language
- TypeScript
- Stars
- 5.9k
- Forks
- 1.8k
- PR merge metrics
- No merged PRs in 30d
Description
Describe the bug
Usage of the keyword using is mentioned in the container action docs here and here.
I went through the docs just to confirm that there isn't any valid syntax using and should instead be uses
Change Proposed
- > NOTE: The location of the repo will be how users will reference your action in their workflow file with the using keyword.
+ > NOTE: The location of the repo will be how users will reference your action in their workflow file with the uses keyword.
- using: actions/setup-node@master
+ - uses: actions/setup-node@master
I would love to make a PR 😄
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
Open docs/container-action.md at the two references linked in the issue and compare the workflow examples with valid GitHub Actions syntax. Correct the two instances of using to uses, then review the rendered documentation or diff to confirm both examples and the explanatory note are accurate.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100