Skip to content

Commit 8440fd9

Browse files
byCedricbyCedric
authored
docs: update badge urls in the readmes (#199)
* docs: update badge urls and header structure * docs(preview-comment): update badge urls and header structure
1 parent e6ba70c commit 8440fd9

2 files changed

Lines changed: 70 additions & 56 deletions

File tree

‎README.md‎

Lines changed: 33 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,35 @@
11
<div align="center">
22
<h1>expo-github-action</h1>
33
<p>Publish, build or manage your <a href="https://github.com/expo/expo">Expo</a> app with GitHub Actions!</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="/blob/main/CHANGELOG.md"><b>Changelog</b></a>
23-
</p>
244
</div>
255

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>
20+
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="/blob/main/CHANGELOG.md"><b>Changelog</b></a>
29+
</p>
30+
31+
<br />
32+
2633
## What's inside?
2734

2835
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:
135142

136143
### Publish a preview from PR
137144

138-
Reviewing pull requests can take some time.
145+
Reviewing pull requests can take some time.
139146
The reviewer needs to check out the branch, install the changes, and run the bundler to review the results.
140147
You can also automatically publish the project for the reviewer to skip those manual steps.
141148

@@ -180,24 +187,24 @@ jobs:
180187

181188
### Automatic Expo login
182189

183-
Some Expo commands, like `expo publish` and `eas build`, require you to be authenticated.
190+
Some Expo commands, like `expo publish` and `eas build`, require you to be authenticated.
184191
This action exports the [**token**][link-expo-token] to ensure you are authenticated in every workflow step.
185192

186193
> 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.
187194

188195
### Using the built-in cache
189196

190197
You can opt-out from caching the Expo and EAS CLI installations.
191-
Under the hood, it uses the [`@actions/cache`][link-actions-cache-package] package to restore a previous install.
198+
Under the hood, it uses the [`@actions/cache`][link-actions-cache-package] package to restore a previous install.
192199
It reduces the installation time because it only needs to download and extract a single tar file.
193200

194201
> 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.
195202

196203
### ENOSPC errors on Linux
197204

198-
Creating new bundles with Metro can be memory intensive.
199-
In the past, some builds resulted in `ENOSPC` errors.
200-
To prevent anyone from running into this, we make sure Ubuntu has sensible defaults in terms of file system availability.
205+
Creating new bundles with Metro can be memory intensive.
206+
In the past, some builds resulted in `ENOSPC` errors.
207+
To prevent anyone from running into this, we make sure Ubuntu has sensible defaults in terms of file system availability.
201208
You can opt-out from patching the file system by setting **patch-watchers** to `false`.
202209

203210
<div align="center">

‎preview-comment/README.md‎

Lines changed: 37 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,37 @@
11
<div align="center">
22
<h1>expo-github-action/preview-comment</h1>
33
<p>Add <a href="https://github.com/expo/expo">Expo</a> preview comments to pull requests</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="#available-outputs"><b>Outputs</b></a>
19-
&nbsp;&nbsp;&mdash;&nbsp;&nbsp;
20-
<a href="#example-workflows"><b>Examples</b></a>
21-
&nbsp;&nbsp;&mdash;&nbsp;&nbsp;
22-
<a href="#things-to-know"><b>Caveats</b></a>
23-
&nbsp;&nbsp;&mdash;&nbsp;&nbsp;
24-
<a href="https://github.com/expo/expo-github-action/blob/main/CHANGELOG.md"><b>Changelog</b></a>
25-
</p>
264
</div>
275

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>
20+
21+
<p align="center">
22+
<a href="#configuration-options"><b>Usage</b></a>
23+
&nbsp;&nbsp;&mdash;&nbsp;&nbsp;
24+
<a href="#available-outputs"><b>Outputs</b></a>
25+
&nbsp;&nbsp;&mdash;&nbsp;&nbsp;
26+
<a href="#example-workflows"><b>Examples</b></a>
27+
&nbsp;&nbsp;&mdash;&nbsp;&nbsp;
28+
<a href="#things-to-know"><b>Caveats</b></a>
29+
&nbsp;&nbsp;&mdash;&nbsp;&nbsp;
30+
<a href="https://github.com/expo/expo-github-action/blob/main/CHANGELOG.md"><b>Changelog</b></a>
31+
</p>
32+
33+
<br />
34+
2835
## What's inside?
2936

3037
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.
4855

4956
## Available outputs
5057

51-
There are a few variables available to generate the comment content.
52-
Some of these variables are also exported as subaction output.
58+
There are a few variables available to generate the comment content.
59+
Some of these variables are also exported as subaction output.
5360
Here is a summary of these variables.
5461

5562
| output name | template name | description |
@@ -89,10 +96,10 @@ jobs:
8996
pull-requests: write # Allow comments on PRs
9097
steps:
9198
- name: 🏗 Setup repo
92-
uses: actions/checkout@v2
99+
uses: actions/checkout@v3
93100

94101
- name: 🏗 Setup Node
95-
uses: actions/setup-node@v2
102+
uses: actions/setup-node@v3
96103
with:
97104
node-version: 16.x
98105
cache: yarn
@@ -117,7 +124,7 @@ jobs:
117124
118125
### Sending preview comments elsewhere
119126
120-
You can also use this action to generate the comment without actually commenting.
127+
You can also use this action to generate the comment without actually commenting.
121128
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.
122129

123130
> See [Available variables](#available-variables) for a list of all outputs.
@@ -134,10 +141,10 @@ jobs:
134141
pull-requests: write # Allow comments on PRs
135142
steps:
136143
- name: 🏗 Setup repo
137-
uses: actions/checkout@v2
144+
uses: actions/checkout@v3
138145
139146
- name: 🏗 Setup Node
140-
uses: actions/setup-node@v2
147+
uses: actions/setup-node@v3
141148
with:
142149
node-version: 16.x
143150
cache: yarn
@@ -174,7 +181,7 @@ jobs:
174181

175182
### Preventing duplicate comments
176183

177-
When automating these preview comments, you have to be careful not to spam a pull request on every successful run.
184+
When automating these preview comments, you have to be careful not to spam a pull request on every successful run.
178185
Every comment contains a generated **message-id** to identify previously made comments and update instead of creating a new comment.
179186

180187
### GitHub tokens

0 commit comments

Comments
 (0)
⚡