Skip to content

Commit

Permalink
Use guidelines in README
Browse files Browse the repository at this point in the history
  • Loading branch information
roryabraham committed Nov 20, 2023
1 parent 28148fe commit 6856964
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions .github/workflows/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,12 +139,11 @@ In order to bundle actions with their dependencies into a single Node.js executa

- When calling your GitHub Action from one of our workflows, you must:
- First call `@actions/checkout`.
- Use the absolute path of the action in GitHub, including the repo name, path, and branch ref, like so:
- Use the relative path of the action in GitHub from the root of this repo, like so:
```yaml
- name: Generate Version
uses: Expensify/App/.github/actions/javascript/bumpVersion@main
uses: ./.github/actions/javascript/bumpVersion
```
Do not try to use a relative path.
- Confusingly, paths in action metadata files (`action.yml`) _must_ use relative paths.

- You can't use any dynamic values or environment variables in a `uses` statement
- In general, it is a best practice to minimize any side-effects of each action. Using atomic ("dumb") actions that have a clear and simple purpose will promote reuse and make it easier to understand the workflows that use them.

0 comments on commit 6856964

Please sign in to comment.