Skip to content

Commit

Permalink
add documentation to help us remember that we must not checkout in th…
Browse files Browse the repository at this point in the history
…ese actions
  • Loading branch information
bdemann committed Sep 20, 2024
1 parent 8183af6 commit b9692fd
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 0 deletions.
27 changes: 27 additions & 0 deletions .github/actions/get_dfx_version/README
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 }}
```
27 changes: 27 additions & 0 deletions .github/actions/get_node_version/README
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 }}
```

0 comments on commit b9692fd

Please sign in to comment.