mirror of
https://github.com/expo/expo-github-action.git
synced 2026-11-15 17:32:45 -10:00
docs: update badge urls in the readmes (#199)
* docs: update badge urls and header structure * docs(preview-comment): update badge urls and header structure
This commit is contained in:
1 parent
e6ba70ca50
commit
8440fd9605
2 files changed
+70
-56
No files matched your search
@@ -1,28 +1,35 @@
|
||||
<div align="center">
|
||||
<h1>expo-github-action</h1>
|
||||
<p>Publish, build or manage your <a href="https://github.com/expo/expo">Expo</a> app with GitHub Actions!</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>
|
||||
—
|
||||
<a href="#example-workflows"><b>Examples</b></a>
|
||||
—
|
||||
<a href="#things-to-know"><b>Caveats</b></a>
|
||||
—
|
||||
<a href="/blob/main/CHANGELOG.md"><b>Changelog</b></a>
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<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>
|
||||
|
||||
<p align="center">
|
||||
<a href="#configuration-options"><b>Usage</b></a>
|
||||
—
|
||||
<a href="#example-workflows"><b>Examples</b></a>
|
||||
—
|
||||
<a href="#things-to-know"><b>Caveats</b></a>
|
||||
—
|
||||
<a href="/blob/main/CHANGELOG.md"><b>Changelog</b></a>
|
||||
</p>
|
||||
|
||||
<br />
|
||||
|
||||
## What's inside?
|
||||
|
||||
With this Expo action, you have full access to [Expo CLI][link-expo-cli] and [EAS CLI][link-eas-cli].
|
||||
@@ -135,7 +142,7 @@ jobs:
|
||||
|
||||
### Publish a preview from PR
|
||||
|
||||
Reviewing pull requests can take some time.
|
||||
Reviewing pull requests can take some time.
|
||||
The reviewer needs to check out the branch, install the changes, and run the bundler to review the results.
|
||||
You can also automatically publish the project for the reviewer to skip those manual steps.
|
||||
|
||||
@@ -180,7 +187,7 @@ jobs:
|
||||
|
||||
### Automatic Expo login
|
||||
|
||||
Some Expo commands, like `expo publish` and `eas build`, require you to be authenticated.
|
||||
Some Expo commands, like `expo publish` and `eas build`, require you to be authenticated.
|
||||
This action exports the [**token**][link-expo-token] to ensure you are authenticated in every workflow step.
|
||||
|
||||
> Note, this action does not store the [token][link-expo-token] anywhere. Each separate workflow job needs to set up the [**token**][link-expo-token] individually.
|
||||
@@ -188,16 +195,16 @@ This action exports the [**token**][link-expo-token] to ensure you are authentic
|
||||
### Using the built-in cache
|
||||
|
||||
You can opt-out from caching the Expo and EAS CLI installations.
|
||||
Under the hood, it uses the [`@actions/cache`][link-actions-cache-package] package to restore a previous install.
|
||||
Under the hood, it uses the [`@actions/cache`][link-actions-cache-package] package to restore a previous install.
|
||||
It reduces the installation time because it only needs to download and extract a single tar file.
|
||||
|
||||
> Note, using cache will count towards your [repo cache limit][link-actions-cache-limit]. Both the Expo and EAS CLI are stored in different caches.
|
||||
|
||||
### ENOSPC errors on Linux
|
||||
|
||||
Creating new bundles with Metro can be memory intensive.
|
||||
In the past, some builds resulted in `ENOSPC` errors.
|
||||
To prevent anyone from running into this, we make sure Ubuntu has sensible defaults in terms of file system availability.
|
||||
Creating new bundles with Metro can be memory intensive.
|
||||
In the past, some builds resulted in `ENOSPC` errors.
|
||||
To prevent anyone from running into this, we make sure Ubuntu has sensible defaults in terms of file system availability.
|
||||
You can opt-out from patching the file system by setting **patch-watchers** to `false`.
|
||||
|
||||
<div align="center">
|
||||
|
||||
+37
-30
@@ -1,30 +1,37 @@
|
||||
<div align="center">
|
||||
<h1>expo-github-action/preview-comment</h1>
|
||||
<p>Add <a href="https://github.com/expo/expo">Expo</a> preview comments to pull requests</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>
|
||||
—
|
||||
<a href="#available-outputs"><b>Outputs</b></a>
|
||||
—
|
||||
<a href="#example-workflows"><b>Examples</b></a>
|
||||
—
|
||||
<a href="#things-to-know"><b>Caveats</b></a>
|
||||
—
|
||||
<a href="https://github.com/expo/expo-github-action/blob/main/CHANGELOG.md"><b>Changelog</b></a>
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<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>
|
||||
|
||||
<p align="center">
|
||||
<a href="#configuration-options"><b>Usage</b></a>
|
||||
—
|
||||
<a href="#available-outputs"><b>Outputs</b></a>
|
||||
—
|
||||
<a href="#example-workflows"><b>Examples</b></a>
|
||||
—
|
||||
<a href="#things-to-know"><b>Caveats</b></a>
|
||||
—
|
||||
<a href="https://github.com/expo/expo-github-action/blob/main/CHANGELOG.md"><b>Changelog</b></a>
|
||||
</p>
|
||||
|
||||
<br />
|
||||
|
||||
## What's inside?
|
||||
|
||||
This (sub)action allows you to comment on pull requests containing Expo QR codes.
|
||||
@@ -48,8 +55,8 @@ Here is a summary of all the input options you can use.
|
||||
|
||||
## Available outputs
|
||||
|
||||
There are a few variables available to generate the comment content.
|
||||
Some of these variables are also exported as subaction output.
|
||||
There are a few variables available to generate the comment content.
|
||||
Some of these variables are also exported as subaction output.
|
||||
Here is a summary of these variables.
|
||||
|
||||
| output name | template name | description |
|
||||
@@ -89,10 +96,10 @@ jobs:
|
||||
pull-requests: write # Allow comments on PRs
|
||||
steps:
|
||||
- name: 🏗 Setup repo
|
||||
uses: actions/checkout@v2
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: 🏗 Setup Node
|
||||
uses: actions/setup-node@v2
|
||||
uses: actions/setup-node@v3
|
||||
with:
|
||||
node-version: 16.x
|
||||
cache: yarn
|
||||
@@ -117,7 +124,7 @@ jobs:
|
||||
|
||||
### Sending preview comments elsewhere
|
||||
|
||||
You can also use this action to generate the comment without actually commenting.
|
||||
You can also use this action to generate the comment without actually commenting.
|
||||
By disabling commenting with **comment** set to `false`, you can reuse this action with any workflow trigger and send it to any service accessible in GitHub Actions.
|
||||
|
||||
> See [Available variables](#available-variables) for a list of all outputs.
|
||||
@@ -134,10 +141,10 @@ jobs:
|
||||
pull-requests: write # Allow comments on PRs
|
||||
steps:
|
||||
- name: 🏗 Setup repo
|
||||
uses: actions/checkout@v2
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: 🏗 Setup Node
|
||||
uses: actions/setup-node@v2
|
||||
uses: actions/setup-node@v3
|
||||
with:
|
||||
node-version: 16.x
|
||||
cache: yarn
|
||||
@@ -174,7 +181,7 @@ jobs:
|
||||
|
||||
### Preventing duplicate comments
|
||||
|
||||
When automating these preview comments, you have to be careful not to spam a pull request on every successful run.
|
||||
When automating these preview comments, you have to be careful not to spam a pull request on every successful run.
|
||||
Every comment contains a generated **message-id** to identify previously made comments and update instead of creating a new comment.
|
||||
|
||||
### GitHub tokens
|
||||
|
||||
Reference in new issue
Block a user