Skip to content

Commit 2606508

Browse files
authored
docs(command): update readme to fix badge (#201)
* docs: update badge urls and header structure * docs(preview-comment): update badge urls and header structure * docs(command): update readme to fix badge
1 parent 8440fd9 commit 2606508

1 file changed

Lines changed: 38 additions & 29 deletions

File tree

command/README.md

Lines changed: 38 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,45 @@
11
<div align="center">
22
<h1>expo-github-action/command</h1>
33
<p>Run <a href="https://github.com/expo/expo-cli">Expo CLI</a> or <a href="https://github.com/expo/eas-cli">EAS CLI</a> command by a comment on the PR</p>
4-
<p>
5-
<a href="https://github.com/expo/expo-github-action/releases">
6-
<img src="https://img.shields.io/github/v/release/expo/expo-github-action" alt="releases" />
7-
</a>
8-
<a href="https://github.com/expo/expo-github-action/actions">
9-
<img src="https://img.shields.io/github/workflow/status/expo/expo-github-action/test" alt="builds" />
10-
</a>
11-
<a href="https://github.com/expo/expo-github-action/blob/main/LICENSE.md">
12-
<img src="https://img.shields.io/github/license/expo/expo-github-action" alt="license" />
13-
</a>
14-
</p>
15-
<p align="center">
16-
<a href="#configuration-options"><b>Usage</b></a>
17-
&nbsp;&nbsp;&mdash;&nbsp;&nbsp;
18-
<a href="#example-workflows"><b>Examples</b></a>
19-
&nbsp;&nbsp;&mdash;&nbsp;&nbsp;
20-
<a href="#things-to-know"><b>Caveats</b></a>
21-
&nbsp;&nbsp;&mdash;&nbsp;&nbsp;
22-
<a href="https://github.com/expo/expo-github-action/blob/main/CHANGELOG.md"><b>Changelog</b></a>
23-
</p>
244
</div>
255

26-
## Experimental
6+
<p align="center">
7+
<a href="https://github.com/expo/expo-github-action/releases" title="Latest release">
8+
<picture>
9+
<source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/github/package-json/v/expo/expo-github-action?style=flat-square&color=0366D6&labelColor=49505A">
10+
<img alt="Latest release" src="https://img.shields.io/github/package-json/v/expo/expo-github-action?style=flat-square&color=0366D6&labelColor=D1D5DA" />
11+
</picture>
12+
</a>
13+
<a href="https://github.com/expo/expo-github-action/actions" title="Workflow status">
14+
<picture>
15+
<source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/github/actions/workflow/status/expo/expo-github-action/test.yml?branch=main&style=flat-square&labelColor=49505A">
16+
<img alt="Workflow status" src="https://img.shields.io/github/actions/workflow/status/expo/expo-github-action/test.yml?branch=main&style=flat-square&labelColor=D1D5DA" />
17+
</picture>
18+
</a>
19+
</p>
2720

28-
**_This sub action is experimental and might change without notice. Use it at your own risk_**
21+
<p align="center">
22+
<a href="#configuration-options"><b>Usage</b></a>
23+
&nbsp;&nbsp;&mdash;&nbsp;&nbsp;
24+
<a href="#example-workflows"><b>Examples</b></a>
25+
&nbsp;&nbsp;&mdash;&nbsp;&nbsp;
26+
<a href="#things-to-know"><b>Caveats</b></a>
27+
&nbsp;&nbsp;&mdash;&nbsp;&nbsp;
28+
<a href="https://github.com/expo/expo-github-action/blob/main/CHANGELOG.md"><b>Changelog</b></a>
29+
</p>
30+
31+
<br />
32+
33+
> **Warning**
34+
> This sub action is experimental and might change without notice. Use it at your own risk
2935
3036
## Configuration options
3137

3238
This action is customizable through variables defined in the [`action.yml`](action.yml).
3339
Here is a summary of all the input options you can use.
3440

35-
| variable | default | description |
36-
| -------------- | --------------------------- | ------------------------------------------------------------------------------------------------ |
41+
| variable | default | description |
42+
| ---------------- | -------------- | ------------------------------------------------------------------------- |
3743
| **github-token** | `github.token` | A GitHub token to use when commenting on PR ([read more](#github-tokens)) |
3844

3945
## Example workflows
@@ -46,13 +52,12 @@ You can read more about this in the [GitHub Actions documentation][link-actions]
4652
This workflow listens to the `issue_comment` event and run the `eas build` command to start a build at Expo.
4753

4854
```yml
49-
name: Expo Comment Bot
5055
on:
5156
issue_comment:
5257
types: [created, edited]
53-
concurrency:
58+
concurrency:
5459
# Limit the max concurrency to only 1 active action per pull
55-
group: bot-${{ github.event.issue.number }}
60+
group: expo-bot-${{ github.event.issue.number }}
5661
cancel-in-progress: true
5762
jobs:
5863
bot:
@@ -64,23 +69,27 @@ jobs:
6469
pull-requests: write
6570
steps:
6671
- name: 🏗 Setup repo
67-
uses: actions/checkout@v2
72+
uses: actions/checkout@v3
6873
with:
6974
# Checkout the repo on the pull
7075
ref: refs/pull/${{ github.event.issue.number }}/merge
76+
7177
- name: 🏗 Setup Node
72-
uses: actions/setup-node@v2
78+
uses: actions/setup-node@v3
7379
with:
7480
node-version: 16.x
7581
cache: yarn
82+
7683
- name: 🏗 Setup Expo
7784
uses: expo/expo-github-action@v7
7885
with:
7986
eas-version: latest
8087
expo-version: latest
8188
token: ${{ secrets.EXPO_TOKEN }}
89+
8290
- name: 📦 Install dependencies
8391
run: yarn install
92+
8493
- name: 🤖 Run expo bot
8594
uses: expo/expo-github-action/command@v7
8695
```

0 commit comments

Comments
 (0)