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
This commit is contained in:
Cedric van Putten authored and GitHub committed 2023-01-04 06:51:11 -08:00
1 parent 8440fd9605
commit 2606508023
1 file changed
+38 -29
+38 -29
View File
@@ -1,39 +1,45 @@
<div align="center">
<h1>expo-github-action/command</h1>
<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>
<p>
<a href="https://github.com/expo/expo-github-action/releases">
<img src="https://img.shields.io/github/v/release/expo/expo-github-action" alt="releases" />
</a>
<a href="https://github.com/expo/expo-github-action/actions">
<img src="https://img.shields.io/github/workflow/status/expo/expo-github-action/test" alt="builds" />
</a>
<a href="https://github.com/expo/expo-github-action/blob/main/LICENSE.md">
<img src="https://img.shields.io/github/license/expo/expo-github-action" alt="license" />
</a>
</p>
<p align="center">
<a href="#configuration-options"><b>Usage</b></a>
&nbsp;&nbsp;&mdash;&nbsp;&nbsp;
<a href="#example-workflows"><b>Examples</b></a>
&nbsp;&nbsp;&mdash;&nbsp;&nbsp;
<a href="#things-to-know"><b>Caveats</b></a>
&nbsp;&nbsp;&mdash;&nbsp;&nbsp;
<a href="https://github.com/expo/expo-github-action/blob/main/CHANGELOG.md"><b>Changelog</b></a>
</p>
</div>
## Experimental
<p align="center">
<a href="https://github.com/expo/expo-github-action/releases" title="Latest release">
<picture>
<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">
<img alt="Latest release" src="https://img.shields.io/github/package-json/v/expo/expo-github-action?style=flat-square&color=0366D6&labelColor=D1D5DA" />
</picture>
</a>
<a href="https://github.com/expo/expo-github-action/actions" title="Workflow status">
<picture>
<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">
<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" />
</picture>
</a>
</p>
**_This sub action is experimental and might change without notice. Use it at your own risk_**
<p align="center">
<a href="#configuration-options"><b>Usage</b></a>
&nbsp;&nbsp;&mdash;&nbsp;&nbsp;
<a href="#example-workflows"><b>Examples</b></a>
&nbsp;&nbsp;&mdash;&nbsp;&nbsp;
<a href="#things-to-know"><b>Caveats</b></a>
&nbsp;&nbsp;&mdash;&nbsp;&nbsp;
<a href="https://github.com/expo/expo-github-action/blob/main/CHANGELOG.md"><b>Changelog</b></a>
</p>
<br />
> **Warning**
> This sub action is experimental and might change without notice. Use it at your own risk
## Configuration options
This action is customizable through variables defined in the [`action.yml`](action.yml).
Here is a summary of all the input options you can use.
| variable | default | description |
| -------------- | --------------------------- | ------------------------------------------------------------------------------------------------ |
| variable | default | description |
| ---------------- | -------------- | ------------------------------------------------------------------------- |
| **github-token** | `github.token` | A GitHub token to use when commenting on PR ([read more](#github-tokens)) |
## Example workflows
@@ -46,13 +52,12 @@ You can read more about this in the [GitHub Actions documentation][link-actions]
This workflow listens to the `issue_comment` event and run the `eas build` command to start a build at Expo.
```yml
name: Expo Comment Bot
on:
issue_comment:
types: [created, edited]
concurrency:
concurrency:
# Limit the max concurrency to only 1 active action per pull
group: bot-${{ github.event.issue.number }}
group: expo-bot-${{ github.event.issue.number }}
cancel-in-progress: true
jobs:
bot:
@@ -64,23 +69,27 @@ jobs:
pull-requests: write
steps:
- name: 🏗 Setup repo
uses: actions/checkout@v2
uses: actions/checkout@v3
with:
# Checkout the repo on the pull
ref: refs/pull/${{ github.event.issue.number }}/merge
- name: 🏗 Setup Node
uses: actions/setup-node@v2
uses: actions/setup-node@v3
with:
node-version: 16.x
cache: yarn
- name: 🏗 Setup Expo
uses: expo/expo-github-action@v7
with:
eas-version: latest
expo-version: latest
token: ${{ secrets.EXPO_TOKEN }}
- name: 📦 Install dependencies
run: yarn install
- name: 🤖 Run expo bot
uses: expo/expo-github-action/command@v7
```