Skip to content

Commit

Permalink
docs: use new table format
Browse files Browse the repository at this point in the history
  • Loading branch information
byCedric committed Jan 14, 2022
1 parent 4595973 commit 0209dde
Showing 1 changed file with 21 additions and 21 deletions.
42 changes: 21 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,17 +34,17 @@ There are some additional features included to make the usage of this action as
This action is customizable through variables; they are defined in the [`action.yml`](action.yml).
Here is a summary of all the variables that you can use and their purpose.

| variable | default | description |
| ---------------- | ------- | ------------------------------------------------------------------------------------ |
| `expo-version` | - | [Expo CLI](https://github.com/expo/expo-cli) version to install, skips when omitted. |
| `expo-cache` | `true` | If it should use the [GitHub actions cache](#using-the-built-in-cache). |
| `eas-version` | - | [EAS CLI](https://github.com/expo/eas-cli) version to install, skips when omitted. |
| `eas-cache` | `true` | If it should use the [GitHub actions cache](#using-the-built-in-cache). |
| `packager` | `yarn` | The package manager to use. _(e.g. `yarn` or `npm`)_ |
| `token` | - | The token of your Expo account |
| `patch-watchers` | `true` | If it should [patch the `fs.inotify.` limits](#enospc-errors-on-linux). |

> Never hardcode `expo-token` in your workflow, use [secrets][link-actions-secrets] to store them.
| variable | default | description |
| ------------------ | ------- | -------------------------------------------------------------------------------------------- |
| **expo-version** | - | Expo CLI version to install (_skips when omitted_) |
| **expo-cache** | `true` | If it should use the GitHub actions cache ([read more](#using-the-built-in-cache)) |
| **eas-version** | - | EAS CLI version to install (_skips install when omitted_) |
| **eas-cache** | `true` | If it should use the GitHub actions cache ([read more](#using-the-built-in-cache)) |
| **packager** | `yarn` | Package manager to use _(e.g. `yarn` or `npm`)_ |
| **token** | - | Token of your Expo account (_only use with [secrets][link-actions-secrets]_) |
| **patch-watchers** | `true` | If it should patch the `fs.inotify.` limits on Ubuntu ([read more](#enospc-errors-on-linux)) |

> Never hardcode `expo-token` in your workflow, use to store them.
> Using `latest` for `eas-version` is recommened, you should always have the latest version of this CLI installed.
Expand Down Expand Up @@ -85,7 +85,7 @@ jobs:
with:
expo-version: 5.x
token: ${{ secrets.EXPO_TOKEN }}

- name: 📦 Install dependencies
run: yarn install

Expand All @@ -112,23 +112,23 @@ jobs:
steps:
- name: 🏗 Setup repo
uses: actions/checkout@v2
- name: 🏗 Setup Node
uses: actions/setup-node@v2
with:
node-version: 16.x
cache: yarn
- name: 🏗 Setup Expo
uses: expo/expo-github-action@v7
with:
eas-version: latest
expo-version: 5.x
token: ${{ secrets.EXPO_TOKEN }}
- name: 📦 Install dependencies
run: yarn install
- name: 🚀 Build app
run: eas build
```
Expand All @@ -149,25 +149,25 @@ jobs:
steps:
- name: 🏗 Setup repo
uses: actions/checkout@v2
- name: 🏗 Setup Node
uses: actions/setup-node@v2
with:
node-version: 16.x
cache: yarn
- name: 🏗 Setup Expo
uses: expo/expo-github-action@v7
with:
expo-version: 5.x
token: ${{ secrets.EXPO_TOKEN }}
- name: 📦 Install dependencies
run: yarn install
- name: 🚀 Publish preview
run: expo publish --release-channel=pr-${{ github.event.number }}
- name: 💬 Comment preview
uses: expo/expo-github-action/preview-comment@v7
env:
Expand Down

0 comments on commit 0209dde

Please sign in to comment.