-
Notifications
You must be signed in to change notification settings - Fork 37
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add documentation to help us remember that we must not checkout in th…
…ese actions
- Loading branch information
Showing
2 changed files
with
54 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
## Prerequisite | ||
|
||
This action assumes that the repository has been checked out before calling the action, typically using `actions/checkout@v4`. If you haven't checked out the code in a previous step, make sure to do so to avoid errors. | ||
|
||
Example usage: | ||
|
||
```yaml | ||
steps: | ||
- uses: actions/checkout@v4 | ||
|
||
- id: get-dfx-version | ||
uses: ./.github/actions/get_dfx_version | ||
``` | ||
|
||
## Output | ||
|
||
The output of this action contains the dfx version that Azle uses. It can be obtained as follows: | ||
|
||
```yaml | ||
steps: | ||
- uses: actions/checkout@v4 | ||
|
||
- id: get-dfx-version | ||
uses: ./.github/actions/get_dfx_version | ||
|
||
- run: echo ${{ steps.get-dfx-version.outputs.dfx-version }} | ||
``` |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
## Prerequisite | ||
|
||
This action assumes that the repository has been checked out before calling the action, typically using `actions/checkout@v4`. If you haven't checked out the code in a previous step, make sure to do so to avoid errors. | ||
|
||
Example usage: | ||
|
||
```yaml | ||
steps: | ||
- uses: actions/checkout@v4 | ||
|
||
- id: get-node-version | ||
uses: ./.github/actions/get_node_version | ||
``` | ||
|
||
## Output | ||
|
||
The output of this action contains the Node.js version that Azle uses. It can be obtained as follows: | ||
|
||
```yaml | ||
steps: | ||
- uses: actions/checkout@v4 | ||
|
||
- id: get-node-version | ||
uses: ./.github/actions/get_node_version | ||
|
||
- run: echo ${{ steps.get-node-version.outputs.node-version }} | ||
``` |