Compare commits

...
11 Commits
Author SHA1 Message Date
Expo CI c7b66a9c32 chore: create new release 8.2.1
## [8.2.1](https://github.com/expo/expo-github-action/compare/8.2.0...8.2.1) (2024-01-15)

### Bug fixes

* **preview:** filter slugs with special characters to match dev clients `exp+<slug>` scheme ([#252](https://github.com/expo/expo-github-action/issues/252)) ([b8a9be8](https://github.com/expo/expo-github-action/commit/b8a9be8336bf5609f8e299a8486f9a2bf7073f8a))
2024-01-15 12:35:54 +00:00
Cedric van Putten b8a9be8336 fix(preview): filter slugs with special characters to match dev clients exp+<slug> scheme (#252)
* test(preview): add tests for eas update qr code urls

* fix(preview): use same filtering of `slug` as done in `expo-dev-client`

* chore: rebuild actions
2024-01-15 13:28:27 +01:00
Expo CI b547b4d94a chore: create new release 8.2.0
## [8.2.0](https://github.com/expo/expo-github-action/compare/8.1.0...8.2.0) (2023-12-02)

### New features

* **preview:** add `qr-target` and use proper QR codes for `expo-go` and `dev-build` ([#247](https://github.com/expo/expo-github-action/issues/247)) ([54efbfd](https://github.com/expo/expo-github-action/commit/54efbfdf1d130888a5f13b73fb7adc85edeb8855))

### Documentation changes

* **preview:** clarify the branch and workflow trigger relations ([#246](https://github.com/expo/expo-github-action/issues/246)) ([ccfad6f](https://github.com/expo/expo-github-action/commit/ccfad6f148eaa709959a64b1be216481f4ca54ff))
2023-12-02 15:49:36 +00:00
Cedric van Putten 54efbfdf1d feature(preview): add qr-target and use proper QR codes for expo-go and dev-build (#247)
* fix(preview): use app slug to generate proper EAS Update preview

* ci(test): remove faulty implemented test case for app schemes

* chore: add jest snapshot workaround for prettier v2

See https://jestjs.io/docs/configuration/\#prettierpath-string

* chore(preview): rebuild preview subaction

* fix(preview): allow users to force EAS Update QR codes to Expo Go

* refactor(preview): use `qr-target` with automatically inferred value instead of `expo-go`

* chore: rebuild files

* refactor(preview): use `dev-build` instead of `dev-client` and validate input

* chore: rebuild files

* test(preview): add e2e test for infered `dev-build` qr code
2023-12-02 16:48:22 +01:00
Cedric van Putten ccfad6f148 docs(preview): clarify the branch and workflow trigger relations (#246) 2023-11-27 09:44:36 +01:00
Expo CI 6a82be3e3e chore: create new release 8.1.0
## [8.1.0](https://github.com/expo/expo-github-action/compare/8.0.0...8.1.0) (2023-11-24)

### New features

* add fingerprint integration ([#231](https://github.com/expo/expo-github-action/issues/231)) ([e6622e0](https://github.com/expo/expo-github-action/commit/e6622e076de31220ec97e3d7494de70cf1ab85b2))
* add readme for preview-build and fingerprint action ([#232](https://github.com/expo/expo-github-action/issues/232)) ([acc171b](https://github.com/expo/expo-github-action/commit/acc171bb5e34cd76bf152307e562bb49e7743b94)), closes [/github.com/expo/expo-github-action/pull/231#pullrequestreview-1628540314](https://github.com/expo//github.com/expo/expo-github-action/pull/231/issues/pullrequestreview-1628540314)
* **preview:** add update manifest permalinks to the output ([#245](https://github.com/expo/expo-github-action/issues/245)) ([331a5ab](https://github.com/expo/expo-github-action/commit/331a5abc4196b7590363c2b3ec842a0a17f98fa2))

### Bug fixes

* **preview:** allow multiple `app.json` schemes ([#244](https://github.com/expo/expo-github-action/issues/244)) ([42d64cf](https://github.com/expo/expo-github-action/commit/42d64cf92010d7210784c0f30bcaa611d8bae55d))

### Code changes

* update error handling to node 20 standards ([#243](https://github.com/expo/expo-github-action/issues/243)) ([65ee055](https://github.com/expo/expo-github-action/commit/65ee05557f89a7804e36b2d3fe4f3d33aea7011a))
* update workflows and repository to use Bun ([#241](https://github.com/expo/expo-github-action/issues/241)) ([7f1c170](https://github.com/expo/expo-github-action/commit/7f1c170873ddbadfb0ba311dd94b43d14c795ee3))
* upgrade all actions to run on node 20 ([#242](https://github.com/expo/expo-github-action/issues/242)) ([b3e5355](https://github.com/expo/expo-github-action/commit/b3e53555d9effcab01011226c5e811c263a449cb))

### Other chores

* **ci:** update release flow with new service account ([#238](https://github.com/expo/expo-github-action/issues/238)) ([e289d93](https://github.com/expo/expo-github-action/commit/e289d93e119801f899eb2b94d80d92718172dba3))
* update release workflow actions ([#239](https://github.com/expo/expo-github-action/issues/239)) ([57dcabe](https://github.com/expo/expo-github-action/commit/57dcabe749340c8c995ee0334cd7c547c35770d0))

### Documentation changes

* add link to breaking change pull request ([9e1a8c8](https://github.com/expo/expo-github-action/commit/9e1a8c8343d0f9405717e103c71e2e3ce9286bbc))
* fix changelog link in readme ([185932d](https://github.com/expo/expo-github-action/commit/185932d43cd424c08c2d530a3cedad352d66e78e))
* update example to use `eas-version` ([#222](https://github.com/expo/expo-github-action/issues/222)) ([7bc946c](https://github.com/expo/expo-github-action/commit/7bc946c5f6b768b1a1858c1722b3aac4e0064c23))
2023-11-24 19:29:42 +00:00
Cedric van Putten 020be2c617 ci(release): fix release workflow github context 2023-11-24 20:20:43 +01:00
Cedric van Putten 331a5abc41 feature(preview): add update manifest permalinks to the output (#245) 2023-11-24 19:09:35 +01:00
Cedric van Putten 42d64cf920 fix(preview): allow multiple app.json schemes (#244)
* ci: add multiple schemes to the e2e tests of preview qr codes

* refactor: update to `@expo/config@8`

* fix(preview): allow multiple app schemes in `app.json` and add `app-scheme` as option

* chore: rebuild files

* ci: add test using custom app scheme in preview action
2023-11-24 18:58:35 +01:00
Cedric van Putten 65ee05557f refactor: update error handling to node 20 standards (#243)
* refactor: update error handling to node 20 standards

* chore: rebuild files
2023-11-24 18:03:01 +01:00
Cedric van Putten b3e53555d9 refactor: upgrade all actions to run on node 20 (#242) 2023-11-24 17:39:41 +01:00
32 changed files with 6403 additions and 5466 deletions

No files matched your search

+1 -1
View File
@@ -8,7 +8,7 @@ inputs:
node-version:
description: Version of Node to use
default: 18.x
default: 20.x
runs:
using: composite
+2
View File
@@ -38,6 +38,8 @@ jobs:
steps:
- name: 🏗 Setup repo
uses: actions/checkout@v4
with:
token: ${{ secrets.EXPOBOT_GITHUB_TOKEN }}
- name: 🏗 Setup runner
uses: ./.github/actions/setup
+50
View File
@@ -84,11 +84,16 @@ jobs:
- name: 🏗 Setup project
run: bun create expo ./temp --template blank
- name: 🏗 Setup `expo-dev-client`
working-directory: ./temp
run: bun expo install expo-dev-client
- name: 👷 Configure project
working-directory: ./temp
run: |
eas init --id ${{ secrets.EXPO_PROJECT_ID }} --force --non-interactive
echo $(jq '.expo.runtimeVersion.policy = "sdkVersion"' app.json) > app.json
echo $(jq '.expo.scheme = ["expogithubaction", "ega"]' app.json) > app.json
- name: 🚀 Create preview (without comment)
if: ${{ env.hasAuth == 'true' }}
@@ -164,6 +169,51 @@ jobs:
throw new Error('Message output is empty');
}
- name: 🚀 Create preview (with "dev-build" QR target)
if: ${{ env.hasAuth == 'true' }}
uses: ./preview
id: dev-build-qr
env:
EXPO_TEST_GITHUB_PULL: 206
with:
working-directory: ./temp
command: eas update --branch test --message "This is a test"
comment: false
- name: 🧪 Comment has "dev-build" QR
if: ${{ env.hasAuth == 'true' }}
uses: actions/github-script@v7
with:
script: |
const qrUrl = `${{ steps.dev-build-qr.outputs.qr }}`
if (!qrUrl || !qrUrl.includes('appScheme')) {
console.log({ qrUrl });
throw new Error('QR URL is missing "appScheme" to point to a dev build');
}
- name: 🚀 Create preview (with "expo-go" QR target from input)
if: ${{ env.hasAuth == 'true' }}
uses: ./preview
id: expo-go-qr
env:
EXPO_TEST_GITHUB_PULL: 206
with:
working-directory: ./temp
qr-target: expo-go
command: eas update --branch test --message "This is a test"
comment: false
- name: 🧪 Comment has "expo-go" QR code
if: ${{ env.hasAuth == 'true' }}
uses: actions/github-script@v7
with:
script: |
const qrUrl = `${{ steps.expo-go-qr.outputs.qr }}`
if (!qrUrl || qrUrl.includes('appScheme')) {
console.log({ qrUrl });
throw new Error('QR URL points to a dev build, not Expo Go');
}
preview-comment:
runs-on: ubuntu-latest
steps:
+53
View File
@@ -1,3 +1,56 @@
## [8.2.1](https://github.com/expo/expo-github-action/compare/8.2.0...8.2.1) (2024-01-15)
### Bug fixes
* **preview:** filter slugs with special characters to match dev clients `exp+<slug>` scheme ([#252](https://github.com/expo/expo-github-action/issues/252)) ([b8a9be8](https://github.com/expo/expo-github-action/commit/b8a9be8336bf5609f8e299a8486f9a2bf7073f8a))
## [8.2.0](https://github.com/expo/expo-github-action/compare/8.1.0...8.2.0) (2023-12-02)
### New features
* **preview:** add `qr-target` and use proper QR codes for `expo-go` and `dev-build` ([#247](https://github.com/expo/expo-github-action/issues/247)) ([54efbfd](https://github.com/expo/expo-github-action/commit/54efbfdf1d130888a5f13b73fb7adc85edeb8855))
### Documentation changes
* **preview:** clarify the branch and workflow trigger relations ([#246](https://github.com/expo/expo-github-action/issues/246)) ([ccfad6f](https://github.com/expo/expo-github-action/commit/ccfad6f148eaa709959a64b1be216481f4ca54ff))
## [8.1.0](https://github.com/expo/expo-github-action/compare/8.0.0...8.1.0) (2023-11-24)
### New features
* add fingerprint integration ([#231](https://github.com/expo/expo-github-action/issues/231)) ([e6622e0](https://github.com/expo/expo-github-action/commit/e6622e076de31220ec97e3d7494de70cf1ab85b2))
* add readme for preview-build and fingerprint action ([#232](https://github.com/expo/expo-github-action/issues/232)) ([acc171b](https://github.com/expo/expo-github-action/commit/acc171bb5e34cd76bf152307e562bb49e7743b94)), closes [/github.com/expo/expo-github-action/pull/231#pullrequestreview-1628540314](https://github.com/expo//github.com/expo/expo-github-action/pull/231/issues/pullrequestreview-1628540314)
* **preview:** add update manifest permalinks to the output ([#245](https://github.com/expo/expo-github-action/issues/245)) ([331a5ab](https://github.com/expo/expo-github-action/commit/331a5abc4196b7590363c2b3ec842a0a17f98fa2))
### Bug fixes
* **preview:** allow multiple `app.json` schemes ([#244](https://github.com/expo/expo-github-action/issues/244)) ([42d64cf](https://github.com/expo/expo-github-action/commit/42d64cf92010d7210784c0f30bcaa611d8bae55d))
### Code changes
* update error handling to node 20 standards ([#243](https://github.com/expo/expo-github-action/issues/243)) ([65ee055](https://github.com/expo/expo-github-action/commit/65ee05557f89a7804e36b2d3fe4f3d33aea7011a))
* update workflows and repository to use Bun ([#241](https://github.com/expo/expo-github-action/issues/241)) ([7f1c170](https://github.com/expo/expo-github-action/commit/7f1c170873ddbadfb0ba311dd94b43d14c795ee3))
* upgrade all actions to run on node 20 ([#242](https://github.com/expo/expo-github-action/issues/242)) ([b3e5355](https://github.com/expo/expo-github-action/commit/b3e53555d9effcab01011226c5e811c263a449cb))
### Other chores
* **ci:** update release flow with new service account ([#238](https://github.com/expo/expo-github-action/issues/238)) ([e289d93](https://github.com/expo/expo-github-action/commit/e289d93e119801f899eb2b94d80d92718172dba3))
* update release workflow actions ([#239](https://github.com/expo/expo-github-action/issues/239)) ([57dcabe](https://github.com/expo/expo-github-action/commit/57dcabe749340c8c995ee0334cd7c547c35770d0))
### Documentation changes
* add link to breaking change pull request ([9e1a8c8](https://github.com/expo/expo-github-action/commit/9e1a8c8343d0f9405717e103c71e2e3ce9286bbc))
* fix changelog link in readme ([185932d](https://github.com/expo/expo-github-action/commit/185932d43cd424c08c2d530a3cedad352d66e78e))
* update example to use `eas-version` ([#222](https://github.com/expo/expo-github-action/issues/222)) ([7bc946c](https://github.com/expo/expo-github-action/commit/7bc946c5f6b768b1a1858c1722b3aac4e0064c23))
## [8.0.0](https://github.com/expo/expo-github-action/compare/7.2.1...8.0.0) (2023-02-20)
+3 -1
View File
@@ -174,7 +174,9 @@ jobs:
- name: 🚀 Create preview
uses: expo/expo-github-action/preview@v8
with:
command: eas update --auto
# `github.event.pull_request.head.ref` is only available on `pull_request` triggers.
# Use your own, or keep the automatically infered branch name from `--auto`, when using different triggers.
command: eas update --auto --branch ${{ github.event.pull_request.head.ref }}
```
## Things to know
+1 -1
View File
@@ -6,7 +6,7 @@ branding:
icon: terminal
color: gray-dark
runs:
using: node16
using: node20
main: build/setup/index.js
inputs:
expo-version:
+669 -629
View File
File diff suppressed because it is too large. Load diff
File diff suppressed because it is too large. Load diff
+793 -761
View File
File diff suppressed because it is too large. Load diff
+1420 -1318
View File
File diff suppressed because it is too large. Load diff
File diff suppressed because it is too large. Load diff
+894 -582
View File
File diff suppressed because it is too large. Load diff
+718 -692
View File
File diff suppressed because it is too large. Load diff
BIN
View File
Binary file not shown.
+1 -1
View File
@@ -6,7 +6,7 @@ branding:
icon: message-circle
color: gray-dark
runs:
using: node16
using: node20
main: ../build/command/index.js
inputs:
github-token:
+1 -1
View File
@@ -6,7 +6,7 @@ branding:
icon: smartphone
color: gray-dark
runs:
using: node16
using: node20
main: ../build/fingerprint/index.js
post: ../build/fingerprint-post/index.js
post-if: success()
+2 -1
View File
@@ -1,8 +1,9 @@
/** @type {import('@jest/types').Config.InitialOptions} */
/** @type {import('jest').Config} */
module.exports = {
verbose: true,
clearMocks: true,
moduleFileExtensions: ['js', 'ts'],
prettierPath: require.resolve('jest-snapshot-prettier'),
testEnvironment: 'node',
testMatch: ['**/*.test.ts'],
transform: {
+7 -4
View File
@@ -1,7 +1,7 @@
{
"private": true,
"name": "expo-github-action",
"version": "8.0.0",
"version": "8.2.1",
"description": "Expo CLI in your GitHub Actions workflow",
"main": "build/index.js",
"repository": {
@@ -31,13 +31,13 @@
"uuid": "^8.3.2"
},
"devDependencies": {
"@expo/config": "^7.0.3",
"@expo/config": "^8.1.2",
"@expo/fingerprint": "^0.1.0",
"@expo/spawn-async": "^1.7.2",
"@semantic-release/changelog": "^6.0.2",
"@semantic-release/exec": "^6.0.3",
"@semantic-release/git": "^10.0.1",
"@tsconfig/node16": "^1.0.3",
"@tsconfig/node20": "^20.1.2",
"@types/jest": "^29.2.5",
"@types/node": "^16.18.11",
"@types/uuid": "^9.0.3",
@@ -47,13 +47,16 @@
"eslint-config-universe": "^12.0.0",
"getenv": "^1.0.0",
"jest": "^29.3.1",
"jest-snapshot-prettier": "npm:prettier@^2.8.8",
"prettier": "^3.1.0",
"semantic-release": "^19.0.5",
"sqlite3": "^5.1.6",
"ts-jest": "^29.0.3",
"typescript": "^5.3.2"
},
"trustedDependencies": ["sqlite3"],
"trustedDependencies": [
"sqlite3"
],
"eslintConfig": {
"extends": "universe/node",
"ignorePatterns": [
+1 -1
View File
@@ -6,7 +6,7 @@ branding:
icon: smartphone
color: gray-dark
runs:
using: node16
using: node20
main: ../build/preview-build/index.js
inputs:
command:
+1 -1
View File
@@ -6,7 +6,7 @@ branding:
icon: message-circle
color: gray-dark
runs:
using: node16
using: node20
main: ../build/preview-comment/index.js
inputs:
project:
+58 -35
View File
@@ -42,27 +42,29 @@ It can help speed up the review process by letting the reviewer load the app dir
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 |
| --------------------- | --------------------------- | ---------------------------------------------------------------------------------------------- |
| **command** | - | EAS CLI command to run when creating updates |
| **working-directory** | - | The relative directory of your Expo app |
| **comment** | `true` | If the action should summarize the EAS Update information as comment on a pull request |
| **comment-id** | _[see code][code-defaults]_ | unique id template to prevent duplicate comments ([read more](#preventing-duplicate-comments)) |
| **github-token** | `github.token` | GitHub token to use when commenting on PR ([read more](#github-tokens)) |
| variable | default | description |
| --------------------- | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **command** | - | EAS CLI command to run when creating updates |
| **working-directory** | - | The relative directory of your Expo app |
| **comment** | `true` | If the action should summarize the EAS Update information as comment on a pull request |
| **comment-id** | _[see code][code-defaults]_ | Unique id template to prevent duplicate comments ([read more](#preventing-duplicate-comments)) |
| **qr-target** | _inferred from project_ | Either `dev-build` or `expo-go`, affects how the EAS Update is opened through the QR code. <br /> Defaults to `dev-build` when `expo-dev-client` is detected within the project. |
| **github-token** | `github.token` | GitHub token to use when commenting on PR ([read more](#github-tokens)) |
## Available outputs
There are a few variables available that you can use to set up your own notifications.
These variables are strings; some may be empty because of your project configuration.
| output name | description |
| ----------------- | ------------------------------------------------------------------------------------------------- |
| **projectId** | The resolved EAS project ID |
| **projectName** | The name of your project ([read more](https://docs.expo.dev/versions/latest/config/app/#name)) |
| **projectSlug** | The slug of your project ([read more](https://docs.expo.dev/versions/latest/config/app/#slug)) |
| **projectScheme** | The (custom) app scheme ([read more](https://docs.expo.dev/versions/latest/config/app/#scheme)) |
| **commentId** | The unique comment ID to prevent duplicate comments ([read more](#preventing-duplicate-comments)) |
| **comment** | The comment with information about the updates |
| output name | description |
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| **projectId** | The resolved EAS project ID |
| **projectName** | The name of your project ([read more](https://docs.expo.dev/versions/latest/config/app/#name)) |
| **projectSlug** | The slug of your project ([read more](https://docs.expo.dev/versions/latest/config/app/#slug)) |
| **projectScheme** | The longest (custom) app scheme ([read more](https://docs.expo.dev/versions/latest/config/app/#scheme)) |
| **projectSchemes** | All (custom) app schemes in order of longest to shortest, as JSON string ([read more](https://docs.expo.dev/versions/latest/config/app/#scheme)) |
| **commentId** | The unique comment ID to prevent duplicate comments ([read more](#preventing-duplicate-comments)) |
| **comment** | The comment with information about the updates |
### Update information
@@ -84,30 +86,32 @@ Some of the EAS Update variables can be shared for all platforms if the [runtime
These variables contain Android-specific update information.
When skipping the Android update, these variables are empty strings.
| output name | description |
| ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| **androidId** | Android-specific update id |
| **androidGroupId** | Update group ID that contains one or more platform-specific updates |
| **androidBranchName** | Branch name that was used when creating this update ([read more](https://docs.expo.dev/eas-update/getting-started/#publish-an-update)) |
| **androidMessage** | Custom message to describe the Android-specific update |
| **androidRuntimeVersion** | Runtime version used for the Android-specific update ([read more](https://docs.expo.dev/eas-update/runtime-versions/)) |
| **androidQR** | Absolute URL to the QR code to load this Android-specific update |
| **androidLink** | Absolute URL to the Android-specific update on [expo.dev](https://expo.dev) |
| output name | description |
| ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| **androidId** | Android-specific update id |
| **androidGroupId** | Update group ID that contains one or more platform-specific updates |
| **androidBranchName** | Branch name that was used when creating this update ([read more](https://docs.expo.dev/eas-update/getting-started/#publish-an-update)) |
| **andriodManifestPermalink** | Absolute URL to the Android-specific update manifest |
| **androidMessage** | Custom message to describe the Android-specific update |
| **androidRuntimeVersion** | Runtime version used for the Android-specific update ([read more](https://docs.expo.dev/eas-update/runtime-versions/)) |
| **androidQR** | Absolute URL to the QR code to load this Android-specific update |
| **androidLink** | Absolute URL to the Android-specific update on [expo.dev](https://expo.dev) |
#### iOS-specific update information
These variables contain iOS-specific update information.
When skipping the iOS update, these variables are empty strings.
| output name | description |
| --------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| **iosId** | iOS-specific update id |
| **iosGroupId** | Update group ID that contains one or more platform-specific updates |
| **iosBranchName** | Branch name that was used when creating this update ([read more](https://docs.expo.dev/eas-update/getting-started/#publish-an-update)) |
| **iosMessage** | Custom message to describe the iOS-specific update |
| **iosRuntimeVersion** | Runtime version used for the iOS-specific update ([read more](https://docs.expo.dev/eas-update/runtime-versions/)) |
| **iosQR** | Absolute URL to the QR code to load this iOS-specific update |
| **iosLink** | Absolute URL to the iOS-specific update on [expo.dev](https://expo.dev) |
| output name | description |
| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- |
| **iosId** | iOS-specific update id |
| **iosGroupId** | Update group ID that contains one or more platform-specific updates |
| **iosBranchName** | Branch name that was used when creating this update ([read more](https://docs.expo.dev/eas-update/getting-started/#publish-an-update)) |
| **iosManifestPermalink** | Absolute URL to the ios-specific update manifest |
| **iosMessage** | Custom message to describe the iOS-specific update |
| **iosRuntimeVersion** | Runtime version used for the iOS-specific update ([read more](https://docs.expo.dev/eas-update/runtime-versions/)) |
| **iosQR** | Absolute URL to the QR code to load this iOS-specific update |
| **iosLink** | Absolute URL to the iOS-specific update on [expo.dev](https://expo.dev) |
## Example workflows
@@ -120,7 +124,13 @@ You can read more about this in the [GitHub Actions documentation][link-actions]
### Create previews on pull requests
This workflow creates a new EAS Update every time a pull request is created or updated.
Since we're using the `--auto` flag, the EAS branch will be named after the GitHub branch, and the message for the update will match the commit's message.
We are using the `--auto`, together with the `--branch`, flag in this example.
- `--auto` will automatically create an update using the current git commit message and git branch.
- `--branch` will overwrite this value infere from git with our own value.
> **Warning**
> GitHub Actions might use a temporary merge branch for PRs. To avoid using this merge branch for our update, we overwrite the branch name from `--auto` with our own `--branch` value.
```yml
on:
@@ -153,7 +163,9 @@ jobs:
- name: 🚀 Create preview
uses: expo/expo-github-action/preview@v8
with:
command: eas update --auto
# `github.event.pull_request.head.ref` is only available on `pull_request` triggers.
# Use your own, or keep the automatically infered branch name from `--auto`, when using different triggers.
command: eas update --auto --branch ${{ github.event.pull_request.head.ref }}
```
### Sending preview information elsewhere
@@ -194,6 +206,8 @@ jobs:
uses: expo/expo-github-action/preview@v8
id: preview
with:
# In this example, we use the `push` trigger which will always use the branch name that was pushed to.
# By using `--auto` we both use the git commit message and branch name for the update.
command: eas update --auto
comment: false
@@ -213,6 +227,13 @@ jobs:
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 them instead of creating a new comment.
### Update branch and workflow triggers
GitHub Actions uses slightly different checkout logic for different workflow triggers.
When using the `push` trigger, GitHub Actions checks out the branch that was pushed to.
But for [`pull_request` triggers][link-gha-trigger-pull], GitHub Actions might use a temporary branch name.
This affects in what "branch" your EAS Update is created when using the `--auto` flag.
### GitHub tokens
When using the GitHub API, you always need to be authenticated.
@@ -228,3 +249,5 @@ You can overwrite the token by adding the `GITHUB_TOKEN` environment variable or
[code-defaults]: ../src/actions/preview.ts#L10
[link-actions]: https://help.github.com/en/categories/automating-your-workflow-with-github-actions
[link-gha-token]: https://docs.github.com/en/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token
[link-gha-trigger-pull]: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request
[link-gha-trigger-push]: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#push
+9 -1
View File
@@ -6,7 +6,7 @@ branding:
icon: smartphone
color: gray-dark
runs:
using: node16
using: node20
main: ../build/preview/index.js
inputs:
command:
@@ -18,6 +18,9 @@ inputs:
default: true
comment-id:
description: unique id template to prevent duplicate comments
qr-target:
description: How the EAS Update is opened through the QR code, either `dev-build` or `expo-go`. Defaults to `dev-build` if `expo-dev-client` is used in project.
required: false
working-directory:
description: The relative directory of your Expo app
required: false
@@ -26,6 +29,11 @@ inputs:
description: GitHub token to use when commenting on PR
required: false
default: ${{ github.token }}
# Below are deprecated and won't be supported anymore
app-scheme:
deprecated: true
description: The (custom) app scheme to use when creating the preview QR code
required: false
outputs:
projectId:
description: The resolved EAS project ID
+66 -10
View File
@@ -1,7 +1,8 @@
import { getBooleanInput, getInput, setOutput, group, setFailed, info } from '@actions/core';
import { getBooleanInput, getInput, setOutput, group, setFailed, info, debug } from '@actions/core';
import { ExpoConfig } from '@expo/config';
import { assertEasVersion, createUpdate, EasUpdate, getUpdateGroupQr, getUpdateGroupWebsite } from '../eas';
import { projectAppType } from '../expo';
import { createIssueComment, hasPullContext, pullContext } from '../github';
import { loadProjectConfig } from '../project';
import { template } from '../utils';
@@ -10,12 +11,19 @@ import { executeAction } from '../worker';
export const MESSAGE_ID = 'projectId:{projectId}';
export function previewInput() {
const qrTarget = getInput('qr-target') || undefined;
if (qrTarget && !['expo-go', 'dev-client'].includes(qrTarget)) {
throw new Error(`Invalid QR code target: "${qrTarget}", expected "expo-go" or "dev-build"`);
}
return {
command: getInput('command'),
shouldComment: !getInput('comment') || getBooleanInput('comment'),
commentId: getInput('comment-id') || MESSAGE_ID,
workingDirectory: getInput('working-directory'),
githubToken: getInput('github-token'),
// Note, `dev-build` is prefered, but `dev-client` is supported to aovid confusion
qrTarget: qrTarget as undefined | 'expo-go' | 'dev-build' | 'dev-client',
};
}
@@ -42,7 +50,7 @@ export async function previewAction(input = previewInput()) {
return setFailed(`Missing 'extra.eas.projectId' in app.json or app.config.js.`);
}
const variables = getVariables(config, updates);
const variables = getVariables(config, updates, input);
const messageId = template(input.commentId, variables);
const messageBody = createSummary(updates, variables);
@@ -95,22 +103,27 @@ function sanitizeCommand(input: string): string {
/**
* Generate useful variables for the message body, and as step outputs.
*/
export function getVariables(config: ExpoConfig, updates: EasUpdate[]) {
export function getVariables(config: ExpoConfig, updates: EasUpdate[], options: ReturnType<typeof previewInput>) {
const projectId: string = config.extra?.eas?.projectId;
const android = updates.find(update => update.platform === 'android');
const ios = updates.find(update => update.platform === 'ios');
const appSchemes = getSchemesInOrderFromConfig(config) || [];
const appSlug = config.slug;
const qrTarget = getQrTarget(options);
return {
// EAS / Expo specific
projectId,
projectName: config.name,
projectSlug: config.slug,
projectScheme: config.scheme || '',
projectSlug: appSlug,
projectScheme: appSchemes[0] || '', // This is the longest scheme from one or more custom app schemes
projectSchemes: JSON.stringify(appSchemes), // These are all custom app schemes, in order from longest to shortest as JSON
// Shared update properties
// Note, only use these properties when the update groups are identical
groupId: updates[0].group,
runtimeVersion: updates[0].runtimeVersion,
qr: getUpdateGroupQr({ projectId, updateGroupId: updates[0].group, appScheme: config.scheme }),
qr: getUpdateGroupQr({ projectId, updateGroupId: updates[0].group, appSlug, qrTarget }),
link: getUpdateGroupWebsite({ projectId, updateGroupId: updates[0].group }),
// These are safe to access regardless of the update groups
branchName: updates[0].branch,
@@ -121,21 +134,64 @@ export function getVariables(config: ExpoConfig, updates: EasUpdate[]) {
androidId: android?.id || '',
androidGroupId: android?.group || '',
androidBranchName: android?.branch || '',
androidManifestPermalink: android?.manifestPermalink || '',
androidMessage: android?.message || '',
androidRuntimeVersion: android?.runtimeVersion || '',
androidQR: android ? getUpdateGroupQr({ projectId, updateGroupId: android.group, appScheme: config.scheme }) : '',
androidQR: android ? getUpdateGroupQr({ projectId, updateGroupId: android.group, appSlug, qrTarget }) : '',
androidLink: android ? getUpdateGroupWebsite({ projectId, updateGroupId: android.group }) : '',
// iOS update
iosId: ios?.id || '',
iosGroupId: ios?.group || '',
iosBranchName: ios?.branch || '',
iosManifestPermalink: ios?.manifestPermalink || '',
iosMessage: ios?.message || '',
iosRuntimeVersion: ios?.runtimeVersion || '',
iosQR: ios ? getUpdateGroupQr({ projectId, updateGroupId: ios.group, appScheme: config.scheme }) : '',
iosQR: ios ? getUpdateGroupQr({ projectId, updateGroupId: ios.group, appSlug, qrTarget }) : '',
iosLink: ios ? getUpdateGroupWebsite({ projectId, updateGroupId: ios.group }) : '',
};
}
export function getQrTarget(input: Pick<ReturnType<typeof previewInput>, 'qrTarget' | 'workingDirectory'>) {
if (!input.qrTarget) {
const appType = projectAppType(input.workingDirectory);
debug(`Using inferred QR code target: "${appType}"`);
return appType;
}
switch (input.qrTarget) {
// Note, `dev-build` is prefered, but `dev-client` is supported to aovid confusion
case 'dev-client':
case 'dev-build':
debug(`Using QR code target: "dev-build"`);
return 'dev-build';
case 'expo-go':
debug(`Using QR code target: "expo-go"`);
return 'expo-go';
default:
throw new Error(`Invalid QR code target: "${input.qrTarget}", expected "expo-go" or "dev-build"`);
}
}
/**
* Retrieve the app schemes, in correct priority order, from project config.
* - If the scheme is a string, return `[scheme]`.
* - If the scheme is an array, return the schemes sorted by length, longest first.
* - If the scheme is empty/incorrect, return an empty array.
*/
export function getSchemesInOrderFromConfig(config: ExpoConfig) {
if (typeof config.scheme === 'string') {
return [config.scheme];
}
if (Array.isArray(config.scheme)) {
return config.scheme.sort((a, b) => b.length - a.length);
}
return [];
}
/**
* Generate the message body for a single update.
* Note, this is not configurable, but you can use the variables used to construct your own.
@@ -157,13 +213,13 @@ function createSummaryHeader(updates: EasUpdate[], vars: ReturnType<typeof getVa
.map(platform => `**${platform}**`)
.join(', ');
const appScheme = vars.projectScheme ? `- Scheme → **${vars.projectScheme}**` : '';
const appSchemes = vars.projectScheme ? `- Scheme → **${JSON.parse(vars.projectSchemes).join('**, **')}**` : '';
return `🚀 Expo preview is ready!
- Project → **${vars.projectSlug}**
- ${platformName} → ${platformValue}
${appScheme}`.trim();
${appSchemes}`.trim();
}
function createSingleQrSummary(updates: EasUpdate[], vars: ReturnType<typeof getVariables>) {
+11 -8
View File
@@ -4,8 +4,6 @@ import type { Platform } from '@expo/config';
import semver from 'semver';
import { URL } from 'url';
import { errorMessage } from './utils';
export interface EasUpdate {
/** The unique ID of the platform specific update */
id: string;
@@ -60,8 +58,8 @@ export async function createUpdate(cwd: string, command: string): Promise<EasUpd
({ stdout } = await getExecOutput((await which('eas', true)) + ` ${command}`, undefined, {
cwd,
}));
} catch (error) {
throw new Error(`Could not create a new EAS Update, reason:\n${errorMessage(error)}`);
} catch (error: unknown) {
throw new Error(`Could not create a new EAS Update`, { cause: error });
}
return JSON.parse(stdout);
@@ -73,16 +71,21 @@ export async function createUpdate(cwd: string, command: string): Promise<EasUpd
export function getUpdateGroupQr({
projectId,
updateGroupId,
appScheme,
appSlug,
qrTarget,
}: {
projectId: string;
updateGroupId: string;
appScheme?: string;
appSlug: string;
qrTarget: 'expo-go' | 'dev-build';
}): string {
const url = new URL('https://qr.expo.dev/eas-update');
if (appScheme) {
url.searchParams.append('appScheme', appScheme);
if (qrTarget === 'dev-build') {
// While the parameter is called `appScheme`, it's actually the app's slug
// This should only be added when using dev clients as target
// See: https://github.com/expo/expo/blob/8ae75dde393e5d2393d446227a1fe2482c75eec3/packages/expo-dev-client/plugin/src/getDefaultScheme.ts#L17
url.searchParams.append('appScheme', appSlug.replace(/[^A-Za-z0-9+\-.]/g, ''));
}
url.searchParams.append('projectId', projectId);
+38 -16
View File
@@ -2,10 +2,9 @@ import { info, exportVariable } from '@actions/core';
import { exec, getExecOutput } from '@actions/exec';
import { which } from '@actions/io';
import { ok as assert } from 'assert';
import path from 'path';
import { URL } from 'url';
import { errorMessage } from './utils';
export type CliName = 'expo' | 'eas';
export type Command = {
@@ -97,8 +96,8 @@ export async function projectOwner(cli: CliName = 'expo'): Promise<string> {
try {
({ stdout } = await getExecOutput(await which(cli), ['whoami'], { silent: true }));
} catch (error) {
throw new Error(`Could not fetch the project owner, reason:\n${errorMessage(error)}`);
} catch (error: unknown) {
throw new Error(`Could not fetch the project owner`, { cause: error });
}
if (!stdout) {
@@ -118,8 +117,8 @@ export async function runCommand(cmd: Command) {
({ stderr, stdout } = await getExecOutput(await which(cmd.cli), cmd.args.concat('--non-interactive'), {
silent: false,
}));
} catch (error) {
throw new Error(`Could not run command ${cmd.args.join(' ')}, reason:\n${errorMessage(error)}`);
} catch (error: unknown) {
throw new Error(`Could not run command ${cmd.args.join(' ')}`, { cause: error });
}
return [stdout.trim(), stderr.trim()];
@@ -133,8 +132,8 @@ export async function easBuild(cmd: Command): Promise<BuildInfo[]> {
({ stdout } = await getExecOutput(await which('eas', true), args, {
silent: false,
}));
} catch (error) {
throw new Error(`Could not run command eas build, reason:\n${errorMessage(error)}`);
} catch (error: unknown) {
throw new Error(`Could not run command eas build`, { cause: error });
}
return JSON.parse(stdout);
@@ -165,8 +164,8 @@ export async function createEasBuildFromRawCommandAsync(
({ stdout } = await getExecOutput((await which('eas', true)) + ` ${cmd}`, extraArgs, {
cwd,
}));
} catch (error) {
throw new Error(`Could not run command eas build, reason:\n${errorMessage(error)}`);
} catch (error: unknown) {
throw new Error(`Could not run command eas build`, { cause: error });
}
return JSON.parse(stdout);
@@ -178,8 +177,8 @@ export async function createEasBuildFromRawCommandAsync(
export async function cancelEasBuildAsync(cwd: string, buildId: string): Promise<void> {
try {
await getExecOutput(await which('eas', true), ['build:cancel', buildId], { cwd });
} catch (e) {
info(`Failed to cancel build ${buildId}: ${errorMessage(e)}`);
} catch (error: unknown) {
info(`Failed to cancel build ${buildId}: ${String(error)}`);
}
}
@@ -193,8 +192,8 @@ export async function queryEasBuildInfoAsync(cwd: string, buildId: string): Prom
silent: true,
});
return JSON.parse(stdout);
} catch (e) {
info(`Failed to query eas build ${buildId}: ${errorMessage(e)}`);
} catch (error: unknown) {
info(`Failed to query eas build ${buildId}: ${String(error)}`);
}
return null;
}
@@ -210,14 +209,37 @@ export async function projectInfo(dir: string): Promise<ProjectInfo> {
cwd: dir,
silent: true,
}));
} catch (error) {
throw new Error(`Could not fetch the project info from ${dir}, reason:\n${errorMessage(error)}`);
} catch (error: unknown) {
throw new Error(`Could not fetch the project info from ${dir}`, { cause: error });
}
const { name, slug, owner } = JSON.parse(stdout);
return { name, slug, owner };
}
/**
* Determine if the current project is using `dev-build` or `expo-go`.
* This is based on the `@expo/cli` check to enable dev client mode.
*
* @see https://github.com/expo/expo/blob/190a80f393bc730eb3f300df52d82b701e4b8ff5/packages/%40expo/cli/src/utils/analytics/getDevClientProperties.ts#L12-L15
*/
export function projectAppType(dir: string): 'expo-go' | 'dev-build' {
const packageFile = path.resolve(dir, 'package.json');
let packageJson: any = {};
try {
packageJson = require(packageFile);
} catch (error: unknown) {
throw new Error(`Could not load the project package file in: ${packageFile}`, { cause: error });
}
if (packageJson?.dependencies?.['expo-dev-client'] || packageJson?.devDependencies?.['expo-dev-client']) {
return 'dev-build';
}
return 'expo-go';
}
/**
* Create a QR code for an update on project, with an optional release channel.
*/
+2 -3
View File
@@ -1,7 +1,6 @@
import { exec, getExecOutput } from '@actions/exec';
import { mkdirP } from '@actions/io';
import { errorMessage } from './utils';
import { cacheTool, tempPath } from './worker';
/**
@@ -14,8 +13,8 @@ export async function resolvePackage(name: string, range: string): Promise<strin
try {
({ stdout } = await getExecOutput('npm', ['info', `${name}@${range}`, 'version', '--json'], { silent: true }));
} catch (error) {
throw new Error(`Could not resolve ${name}@${range}, reason:\n${errorMessage(error)}`);
} catch (error: unknown) {
throw new Error(`Could not resolve ${name}@${range}`, { cause: error });
}
// thanks npm, for returning a "" json string value for invalid versions
+2 -4
View File
@@ -1,8 +1,6 @@
import { getExecOutput } from '@actions/exec';
import { ExpoConfig } from '@expo/config';
import { errorMessage } from './utils';
/**
* Load the Expo app project config in the given directory.
* This runs `expo config` command instead of using `@expo/config` directly,
@@ -16,8 +14,8 @@ export async function loadProjectConfig(cwd: string): Promise<ExpoConfig> {
cwd,
silent: true,
}));
} catch (error) {
throw new Error(`Could not fetch the project info from ${cwd}, reason:\n${errorMessage(error)}`);
} catch (error: unknown) {
throw new Error(`Could not fetch the project info from ${cwd}`, { cause: error });
}
return JSON.parse(stdout);
-12
View File
@@ -9,15 +9,3 @@ export function template(template: string, replacements: Record<string, string>)
}
return result;
}
export function errorMessage(error: Error | unknown): string {
if (error instanceof Error) {
return error.message;
}
if (typeof error === 'string') {
return error;
}
return 'Unknown error';
}
+1 -3
View File
@@ -4,8 +4,6 @@ import { ok as assert } from 'assert';
import os from 'os';
import path from 'path';
import { errorMessage } from './utils';
export { find as findTool, cacheDir as cacheTool } from '@actions/tool-cache';
/**
@@ -56,7 +54,7 @@ export async function patchWatchers(): Promise<void> {
} catch (error) {
warning(`Looks like we can't patch watchers/inotify limits, you might encouter the 'ENOSPC' error.`);
warning('For more info: https://github.com/expo/expo-github-action/issues/20, encountered error:');
warning(errorMessage(error));
warning(String(error));
}
}
+122 -44
View File
@@ -1,7 +1,20 @@
import { ExpoConfig } from '@expo/config';
import { createSummary, getVariables } from '../../src/actions/preview';
import {
createSummary,
getQrTarget,
getSchemesInOrderFromConfig,
getVariables,
previewInput,
} from '../../src/actions/preview';
import { EasUpdate } from '../../src/eas';
import { projectAppType } from '../../src/expo';
jest.mock('../../src/expo');
const fakeOptions = {
qrTarget: 'dev-client',
} as unknown as ReturnType<typeof previewInput>;
const fakeExpoConfig = {
slug: 'fake-project',
@@ -37,10 +50,58 @@ const fakeUpdatesSingle: EasUpdate[] = [
const fakeUpdatesMultiple = fakeUpdatesSingle.map(update => ({ ...update, group: `fake-group-${update.id}` }));
describe(getQrTarget, () => {
it('returns `dev-build` for `qr-target: dev-build`', () => {
expect(getQrTarget({ ...fakeOptions, qrTarget: 'dev-build' })).toBe('dev-build');
});
it('returns `dev-build` for `qr-target: dev-client`', () => {
expect(getQrTarget({ ...fakeOptions, qrTarget: 'dev-client' })).toBe('dev-build');
});
it('returns `expo-go` for `qr-target: expo-go`', () => {
expect(getQrTarget({ ...fakeOptions, qrTarget: 'expo-go' })).toBe('expo-go');
});
it('throws for unknown `qr-target`', () => {
expect(() => getQrTarget({ ...fakeOptions, qrTarget: 'unknown' } as any)).toThrow(
`Invalid QR code target: "unknown", expected "expo-go" or "dev-build"`
);
});
it('returns infered `dev-build` when input is omitted', () => {
jest.mocked(projectAppType).mockReturnValue('dev-build');
expect(getQrTarget({ ...fakeOptions, qrTarget: undefined })).toBe('dev-build');
});
it('returns infered `expo-go` when input is omitted', () => {
jest.mocked(projectAppType).mockReturnValue('expo-go');
expect(getQrTarget({ ...fakeOptions, qrTarget: undefined })).toBe('expo-go');
});
});
describe(getSchemesInOrderFromConfig, () => {
it('returns empty array when not defined', () => {
expect(getSchemesInOrderFromConfig({} as ExpoConfig)).toEqual([]);
});
it('returns scheme as array when defined as string', () => {
expect(getSchemesInOrderFromConfig({ scheme: 'ega' } as ExpoConfig)).toEqual(['ega']);
});
it('returns schemes in order when defined as array', () => {
expect(getSchemesInOrderFromConfig({ scheme: ['ega', 'expogithubaction'] } as ExpoConfig)).toEqual([
'expogithubaction',
'ega',
]);
});
});
describe(createSummary, () => {
describe('single update group', () => {
it('returns expected message for both platforms', () => {
expect(createSummary(fakeUpdatesSingle, getVariables(fakeExpoConfig, fakeUpdatesSingle))).toMatchInlineSnapshot(`
expect(createSummary(fakeUpdatesSingle, getVariables(fakeExpoConfig, fakeUpdatesSingle, fakeOptions)))
.toMatchInlineSnapshot(`
"🚀 Expo preview is ready!
- Project → **fake-project**
@@ -48,25 +109,25 @@ describe(createSummary, () => {
- Runtime Version → **exposdk:47.0.0**
- **[More info](https://expo.dev/projects/fake-project-id/updates/fake-group-id)**
<a href="https://qr.expo.dev/eas-update?projectId=fake-project-id&groupId=fake-group-id"><img src="https://qr.expo.dev/eas-update?projectId=fake-project-id&groupId=fake-group-id" width="250px" height="250px" /></a>
<a href="https://qr.expo.dev/eas-update?appScheme=fake-project&projectId=fake-project-id&groupId=fake-group-id"><img src="https://qr.expo.dev/eas-update?appScheme=fake-project&projectId=fake-project-id&groupId=fake-group-id" width="250px" height="250px" /></a>
> Learn more about [𝝠 Expo Github Action](https://github.com/expo/expo-github-action/tree/main/preview#example-workflows)"
`);
});
it('returns expected message for both platforms with custom app scheme', () => {
const customSchemeConfig = { ...fakeExpoConfig, scheme: 'expogithubaction' };
expect(createSummary(fakeUpdatesSingle, getVariables(customSchemeConfig, fakeUpdatesSingle)))
const customSchemeConfig = { ...fakeExpoConfig, scheme: ['ega', 'expogithubaction'] };
expect(createSummary(fakeUpdatesSingle, getVariables(customSchemeConfig, fakeUpdatesSingle, fakeOptions)))
.toMatchInlineSnapshot(`
"🚀 Expo preview is ready!
- Project → **fake-project**
- Platforms → **android**, **ios**
- Scheme → **expogithubaction**
- Scheme → **expogithubaction**, **ega**
- Runtime Version → **exposdk:47.0.0**
- **[More info](https://expo.dev/projects/fake-project-id/updates/fake-group-id)**
<a href="https://qr.expo.dev/eas-update?appScheme=expogithubaction&projectId=fake-project-id&groupId=fake-group-id"><img src="https://qr.expo.dev/eas-update?appScheme=expogithubaction&projectId=fake-project-id&groupId=fake-group-id" width="250px" height="250px" /></a>
<a href="https://qr.expo.dev/eas-update?appScheme=fake-project&projectId=fake-project-id&groupId=fake-group-id"><img src="https://qr.expo.dev/eas-update?appScheme=fake-project&projectId=fake-project-id&groupId=fake-group-id" width="250px" height="250px" /></a>
> Learn more about [𝝠 Expo Github Action](https://github.com/expo/expo-github-action/tree/main/preview#example-workflows)"
`);
@@ -74,7 +135,7 @@ describe(createSummary, () => {
it('returns expected message for android only', () => {
const fakeUpdate = fakeUpdatesSingle.filter(update => update.platform === 'android');
expect(createSummary(fakeUpdate, getVariables(fakeExpoConfig, fakeUpdate))).toMatchInlineSnapshot(`
expect(createSummary(fakeUpdate, getVariables(fakeExpoConfig, fakeUpdate, fakeOptions))).toMatchInlineSnapshot(`
"🚀 Expo preview is ready!
- Project → **fake-project**
@@ -82,7 +143,7 @@ describe(createSummary, () => {
- Runtime Version → **exposdk:47.0.0**
- **[More info](https://expo.dev/projects/fake-project-id/updates/fake-group-id)**
<a href="https://qr.expo.dev/eas-update?projectId=fake-project-id&groupId=fake-group-id"><img src="https://qr.expo.dev/eas-update?projectId=fake-project-id&groupId=fake-group-id" width="250px" height="250px" /></a>
<a href="https://qr.expo.dev/eas-update?appScheme=fake-project&projectId=fake-project-id&groupId=fake-group-id"><img src="https://qr.expo.dev/eas-update?appScheme=fake-project&projectId=fake-project-id&groupId=fake-group-id" width="250px" height="250px" /></a>
> Learn more about [𝝠 Expo Github Action](https://github.com/expo/expo-github-action/tree/main/preview#example-workflows)"
`);
@@ -90,7 +151,7 @@ describe(createSummary, () => {
it('returns expected message for ios only', () => {
const fakeUpdate = fakeUpdatesSingle.filter(update => update.platform === 'ios');
expect(createSummary(fakeUpdate, getVariables(fakeExpoConfig, fakeUpdate))).toMatchInlineSnapshot(`
expect(createSummary(fakeUpdate, getVariables(fakeExpoConfig, fakeUpdate, fakeOptions))).toMatchInlineSnapshot(`
"🚀 Expo preview is ready!
- Project → **fake-project**
@@ -98,7 +159,7 @@ describe(createSummary, () => {
- Runtime Version → **exposdk:47.0.0**
- **[More info](https://expo.dev/projects/fake-project-id/updates/fake-group-id)**
<a href="https://qr.expo.dev/eas-update?projectId=fake-project-id&groupId=fake-group-id"><img src="https://qr.expo.dev/eas-update?projectId=fake-project-id&groupId=fake-group-id" width="250px" height="250px" /></a>
<a href="https://qr.expo.dev/eas-update?appScheme=fake-project&projectId=fake-project-id&groupId=fake-group-id"><img src="https://qr.expo.dev/eas-update?appScheme=fake-project&projectId=fake-project-id&groupId=fake-group-id" width="250px" height="250px" /></a>
> Learn more about [𝝠 Expo Github Action](https://github.com/expo/expo-github-action/tree/main/preview#example-workflows)"
`);
@@ -107,7 +168,56 @@ describe(createSummary, () => {
describe('mutliple update groups', () => {
it('returns expected message for both platforms', () => {
expect(createSummary(fakeUpdatesMultiple, getVariables(fakeExpoConfig, fakeUpdatesMultiple)))
expect(createSummary(fakeUpdatesMultiple, getVariables(fakeExpoConfig, fakeUpdatesMultiple, fakeOptions)))
.toMatchInlineSnapshot(`
"🚀 Expo preview is ready!
- Project → **fake-project**
- Platforms → **android**, **ios**
Android <br /> _(exposdk:47.0.0)_ <br /> **[More info](https://expo.dev/projects/fake-project-id/updates/fake-group-fake-android-id)** | iOS <br /> _(exposdk:47.0.0)_ <br /> **[More info](https://expo.dev/projects/fake-project-id/updates/fake-group-fake-ios-id)**
--- | ---
<a href="https://qr.expo.dev/eas-update?appScheme=fake-project&projectId=fake-project-id&groupId=fake-group-fake-android-id"><img src="https://qr.expo.dev/eas-update?appScheme=fake-project&projectId=fake-project-id&groupId=fake-group-fake-android-id" width="250px" height="250px" /></a> | <a href="https://qr.expo.dev/eas-update?appScheme=fake-project&projectId=fake-project-id&groupId=fake-group-fake-ios-id"><img src="https://qr.expo.dev/eas-update?appScheme=fake-project&projectId=fake-project-id&groupId=fake-group-fake-ios-id" width="250px" height="250px" /></a>
> Learn more about [𝝠 Expo Github Action](https://github.com/expo/expo-github-action/tree/main/preview#example-workflows)"
`);
});
it('returns expected message for android only', () => {
const fakeUpdate = fakeUpdatesSingle.filter(update => update.platform === 'android');
expect(createSummary(fakeUpdate, getVariables(fakeExpoConfig, fakeUpdate, fakeOptions))).toMatchInlineSnapshot(`
"🚀 Expo preview is ready!
- Project → **fake-project**
- Platform → **android**
- Runtime Version → **exposdk:47.0.0**
- **[More info](https://expo.dev/projects/fake-project-id/updates/fake-group-id)**
<a href="https://qr.expo.dev/eas-update?appScheme=fake-project&projectId=fake-project-id&groupId=fake-group-id"><img src="https://qr.expo.dev/eas-update?appScheme=fake-project&projectId=fake-project-id&groupId=fake-group-id" width="250px" height="250px" /></a>
> Learn more about [𝝠 Expo Github Action](https://github.com/expo/expo-github-action/tree/main/preview#example-workflows)"
`);
});
it('returns expected message for ios only', () => {
const fakeUpdate = fakeUpdatesSingle.filter(update => update.platform === 'ios');
expect(createSummary(fakeUpdate, getVariables(fakeExpoConfig, fakeUpdate, fakeOptions))).toMatchInlineSnapshot(`
"🚀 Expo preview is ready!
- Project → **fake-project**
- Platform → **ios**
- Runtime Version → **exposdk:47.0.0**
- **[More info](https://expo.dev/projects/fake-project-id/updates/fake-group-id)**
<a href="https://qr.expo.dev/eas-update?appScheme=fake-project&projectId=fake-project-id&groupId=fake-group-id"><img src="https://qr.expo.dev/eas-update?appScheme=fake-project&projectId=fake-project-id&groupId=fake-group-id" width="250px" height="250px" /></a>
> Learn more about [𝝠 Expo Github Action](https://github.com/expo/expo-github-action/tree/main/preview#example-workflows)"
`);
});
it('returns Expo Go compatible QR code when forced', () => {
const customOptions: typeof fakeOptions = { ...fakeOptions, qrTarget: 'expo-go' };
expect(createSummary(fakeUpdatesMultiple, getVariables(fakeExpoConfig, fakeUpdatesMultiple, customOptions)))
.toMatchInlineSnapshot(`
"🚀 Expo preview is ready!
@@ -121,37 +231,5 @@ describe(createSummary, () => {
> Learn more about [𝝠 Expo Github Action](https://github.com/expo/expo-github-action/tree/main/preview#example-workflows)"
`);
});
it('returns expected message for android only', () => {
const fakeUpdate = fakeUpdatesSingle.filter(update => update.platform === 'android');
expect(createSummary(fakeUpdate, getVariables(fakeExpoConfig, fakeUpdate))).toMatchInlineSnapshot(`
"🚀 Expo preview is ready!
- Project → **fake-project**
- Platform → **android**
- Runtime Version → **exposdk:47.0.0**
- **[More info](https://expo.dev/projects/fake-project-id/updates/fake-group-id)**
<a href="https://qr.expo.dev/eas-update?projectId=fake-project-id&groupId=fake-group-id"><img src="https://qr.expo.dev/eas-update?projectId=fake-project-id&groupId=fake-group-id" width="250px" height="250px" /></a>
> Learn more about [𝝠 Expo Github Action](https://github.com/expo/expo-github-action/tree/main/preview#example-workflows)"
`);
});
it('returns expected message for ios only', () => {
const fakeUpdate = fakeUpdatesSingle.filter(update => update.platform === 'ios');
expect(createSummary(fakeUpdate, getVariables(fakeExpoConfig, fakeUpdate))).toMatchInlineSnapshot(`
"🚀 Expo preview is ready!
- Project → **fake-project**
- Platform → **ios**
- Runtime Version → **exposdk:47.0.0**
- **[More info](https://expo.dev/projects/fake-project-id/updates/fake-group-id)**
<a href="https://qr.expo.dev/eas-update?projectId=fake-project-id&groupId=fake-group-id"><img src="https://qr.expo.dev/eas-update?projectId=fake-project-id&groupId=fake-group-id" width="250px" height="250px" /></a>
> Learn more about [𝝠 Expo Github Action](https://github.com/expo/expo-github-action/tree/main/preview#example-workflows)"
`);
});
});
});
+36
View File
@@ -0,0 +1,36 @@
import { getUpdateGroupQr } from '../src/eas';
describe(getUpdateGroupQr, () => {
it('returns url for expo-go', () => {
expect(
getUpdateGroupQr({
qrTarget: 'expo-go',
projectId: 'projectId',
updateGroupId: 'updateGroupId',
appSlug: 'appslug',
})
).toBe('https://qr.expo.dev/eas-update?projectId=projectId&groupId=updateGroupId');
});
it('returns url for dev-build', () => {
expect(
getUpdateGroupQr({
qrTarget: 'dev-build',
projectId: 'projectId',
updateGroupId: 'updateGroupId',
appSlug: 'appslug',
})
).toBe('https://qr.expo.dev/eas-update?appScheme=appslug&projectId=projectId&groupId=updateGroupId');
});
it('returns url for dev-build, with `_` in appSlug', () => {
expect(
getUpdateGroupQr({
qrTarget: 'dev-build',
projectId: 'projectId',
updateGroupId: 'updateGroupId',
appSlug: 'hello_world',
})
).toBe('https://qr.expo.dev/eas-update?appScheme=helloworld&projectId=projectId&groupId=updateGroupId');
});
});
+4 -2
View File
@@ -1,8 +1,10 @@
{
"extends": "@tsconfig/node16",
"extends": "@tsconfig/node20",
"compilerOptions": {
"outDir": "./build",
"rootDir": "./src"
"rootDir": "./src",
"module": "CommonJS",
"moduleResolution": "node"
},
"exclude": [
"build",