mirror of
https://github.com/expo/expo-github-action.git
synced 2026-11-15 17:32:45 -10:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f6b6254e5d | ||
|
|
4908a48f1b | ||
|
|
3f9e947963 | ||
|
|
ee415b027a | ||
|
|
414c1693e6 | ||
|
|
4f28493708 | ||
|
|
3134e26b3a | ||
|
|
3bf9181edb | ||
|
|
39b0d361f7 | ||
|
|
f1fe877592 | ||
|
|
ff2ff0f980 | ||
|
|
1cfa7bbd9e | ||
|
|
8a7306a978 | ||
|
|
c20146f3b7 | ||
|
|
a9b9cfef50 | ||
|
|
3b3e6b8031 | ||
|
|
186ef0011a | ||
|
|
45b79a05ef | ||
|
|
0b1822a935 | ||
|
|
b60246939f | ||
|
|
b099f17d58 | ||
|
|
50c0ef9028 | ||
|
|
92ec93fa37 | ||
|
|
5f5673ba77 | ||
|
|
1c8e5a21e9 | ||
|
|
3ba667b43f | ||
|
|
f14253ea9c | ||
|
|
a2d9b1cadf | ||
|
|
def44e2c77 | ||
|
|
c3c02de017 | ||
|
|
8b43bae073 | ||
|
|
a03876e3c5 | ||
|
|
04692c3cb1 | ||
|
|
1b57c37e9b | ||
|
|
76ce4de80e | ||
|
|
a888e4f311 | ||
|
|
2662a5f0de | ||
|
|
d4dc05e178 | ||
|
|
04e3b32e94 | ||
|
|
a11a47a3e8 | ||
|
|
79ebfbc3b8 | ||
|
|
6b8c488fd6 | ||
|
|
f13b0ea032 | ||
|
|
6354b0a047 | ||
|
|
da4e75428b | ||
|
|
6bc0bedbc7 | ||
|
|
9c0e696251 | ||
|
|
8275e8fa89 | ||
|
|
4ec7251759 | ||
|
|
6c0f4d78ba | ||
|
|
917e072b54 | ||
|
|
ed7f67d90e | ||
|
|
13d78207a1 | ||
|
|
75b743cff5 | ||
|
|
187c4adfcc | ||
|
|
0eb46e97d7 | ||
|
|
5d3c1cdff4 | ||
|
|
ce1c6b612a | ||
|
|
b807fa603f | ||
|
|
1010edb8c8 | ||
|
|
b80de3494e | ||
|
|
f773f9c85c | ||
|
|
1c36889886 | ||
|
|
ce3c32e185 | ||
|
|
050b7019f7 | ||
|
|
404bd09c6f | ||
|
|
d3602b92b2 | ||
|
|
6ac67f03d0 | ||
|
|
b8a49f4d14 | ||
|
|
84e06132b2 | ||
|
|
71dfeab7a0 | ||
|
|
f6dba4e7ce | ||
|
|
586d2b1bea | ||
|
|
39cd204496 | ||
|
|
58185fbf10 | ||
|
|
a4955da38e | ||
|
|
cb490968ad | ||
|
|
42793272a5 | ||
|
|
a7b6ce4357 | ||
|
|
32b5f9cee8 | ||
|
|
4aaf05ff10 | ||
|
|
1cf961c401 | ||
|
|
69801f0afc | ||
|
|
3ac4a96cb4 | ||
|
|
f80ef1f629 | ||
|
|
2de5b8c3bd | ||
|
|
48288d587a | ||
|
|
12f58a21ef | ||
|
|
7776e33fb4 | ||
|
|
4aa2c230ec | ||
|
|
e5677e1fa3 | ||
|
|
68a2de09aa | ||
|
|
831bcb12d3 | ||
|
|
8ff07e0da8 | ||
|
|
16d4b1519f | ||
|
|
cbd9aceff6 | ||
|
|
a80a00b2cd | ||
|
|
38e963b075 | ||
|
|
929a76ca04 | ||
|
|
00692c48ca | ||
|
|
b2929e3879 | ||
|
|
04cd479159 | ||
|
|
cec6e505c1 | ||
|
|
22df52e066 | ||
|
|
98b1bea09b | ||
|
|
e72ddd8c15 | ||
|
|
26c734a57d | ||
|
|
f3bc71a12a | ||
|
|
4766fa83e2 | ||
|
|
caf499b677 | ||
|
|
5cfaee20e5 | ||
|
|
81344e4392 | ||
|
|
89005bc95d | ||
|
|
55b9dc47a8 | ||
|
|
882d5f940b | ||
|
|
cd33736735 | ||
|
|
d1909bbd24 | ||
|
|
d9cb1dbb0e | ||
|
|
aff8989f53 | ||
|
|
698a1c68a5 | ||
|
|
4c25ef9693 | ||
|
|
aa752f2bde | ||
|
|
fa422416ae | ||
|
|
92beb0f493 |
No files matched your search
@@ -0,0 +1,8 @@
|
||||
root = true
|
||||
|
||||
[*]
|
||||
charset = utf-8
|
||||
end_of_line = lf
|
||||
indent_size = 2
|
||||
indent_style = space
|
||||
insert_final_newline = true
|
||||
@@ -0,0 +1,16 @@
|
||||
module.exports = {
|
||||
ignorePatterns: ['/build/**', 'node_modules/**'],
|
||||
parser: '@typescript-eslint/parser',
|
||||
plugins: ['@typescript-eslint', 'jest', 'prettier'],
|
||||
env: {
|
||||
es6: true,
|
||||
'jest/globals': true,
|
||||
node: true,
|
||||
},
|
||||
extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended'],
|
||||
rules: {
|
||||
'@typescript-eslint/explicit-member-accessibility': ['error', { accessibility: 'no-public' }],
|
||||
'@typescript-eslint/no-var-requires': 'off',
|
||||
'prettier/prettier': 'error',
|
||||
},
|
||||
};
|
||||
@@ -0,0 +1,6 @@
|
||||
# Handle line endings automatically for files detected as text
|
||||
# and leave all files detected as binary untouched.
|
||||
* text=auto
|
||||
|
||||
# These files are text and should be normalized (Convert crlf => lf)
|
||||
build/** text eol=lf
|
||||
@@ -0,0 +1,43 @@
|
||||
name: release
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
release:
|
||||
description: 'type "release" to create the release (main branch only)'
|
||||
required: false
|
||||
|
||||
concurrency:
|
||||
group: release
|
||||
cancel-in-progress: true
|
||||
|
||||
env:
|
||||
release: ${{ github.ref == 'refs/heads/main' && github.event.inputs.release == 'release' }}
|
||||
|
||||
jobs:
|
||||
release:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: 🏗 Setup repo
|
||||
uses: actions/checkout@v2
|
||||
|
||||
- name: 🏗 Setup Node
|
||||
uses: actions/setup-node@v2
|
||||
with:
|
||||
node-version: 16.x
|
||||
cache: yarn
|
||||
|
||||
- name: 📦 Install dependencies
|
||||
run: yarn install --frozen-lockfile --check-files
|
||||
|
||||
- name: 📋 Dry-running release
|
||||
if: ${{ !env.release }}
|
||||
run: yarn semantic-release --dry-run
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: 📋 Release code
|
||||
if: ${{ env.release }}
|
||||
run: yarn semantic-release
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
@@ -0,0 +1,56 @@
|
||||
name: review
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [main]
|
||||
pull_request:
|
||||
types: [opened, synchronize]
|
||||
|
||||
concurrency:
|
||||
group: review-${{ github.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
build:
|
||||
strategy:
|
||||
matrix:
|
||||
node: [16.x]
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: 🏗 Setup repo
|
||||
uses: actions/checkout@v2
|
||||
|
||||
- name: 🏗 Setup Node
|
||||
uses: actions/setup-node@v2
|
||||
with:
|
||||
node-version: ${{ matrix.node }}
|
||||
cache: yarn
|
||||
|
||||
- name: 📦 Install dependencies
|
||||
run: yarn install --frozen-lockfile --check-files
|
||||
|
||||
- name: ✅ Lint code
|
||||
run: yarn lint
|
||||
|
||||
- name: 🧪 Test code
|
||||
run: yarn test
|
||||
|
||||
- name: 👷 Build code
|
||||
run: yarn clean && yarn build
|
||||
|
||||
- name: 🕵️ Validate build
|
||||
id: diff
|
||||
run: |
|
||||
if [ "$(git diff --ignore-space-at-eol build/ | wc -l)" -gt "0" ]; then
|
||||
echo "⚠️ Build is outdated"
|
||||
echo " > run 'yarn clean', 'yarn build', and commit changes"
|
||||
git diff
|
||||
exit 1
|
||||
fi
|
||||
|
||||
- name: 🗂 Upload build
|
||||
uses: actions/upload-artifact@v2
|
||||
if: ${{ failure() && steps.diff.conclusion == 'failure' }}
|
||||
with:
|
||||
name: build
|
||||
path: build/
|
||||
@@ -0,0 +1,45 @@
|
||||
name: test
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [main]
|
||||
workflow_dispatch:
|
||||
|
||||
concurrency:
|
||||
group: test-${{ github.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
setup:
|
||||
strategy:
|
||||
matrix:
|
||||
os:
|
||||
- macos-latest
|
||||
- ubuntu-latest
|
||||
- windows-latest
|
||||
runs-on: ${{ matrix.os }}
|
||||
steps:
|
||||
- name: 🏗 Setup repo
|
||||
uses: actions/checkout@v2
|
||||
|
||||
- name: 🏗 Setup Expo
|
||||
uses: ./
|
||||
with:
|
||||
eas-version: latest
|
||||
eas-cache: true
|
||||
expo-version: latest
|
||||
expo-cache: true
|
||||
token: ${{ secrets.EXPO_TOKEN }}
|
||||
|
||||
- name: 🧪 EAS installed
|
||||
run: eas --version
|
||||
|
||||
- name: 🧪 EAS authenticated
|
||||
run: eas whoami
|
||||
|
||||
- name: 🧪 Expo installed
|
||||
run: expo --version
|
||||
|
||||
- name: 🧪 Expo authenticated
|
||||
run: expo whoami
|
||||
|
||||
+51
@@ -0,0 +1,51 @@
|
||||
# SWC
|
||||
.swc/
|
||||
|
||||
# macOS
|
||||
.DS_Store
|
||||
|
||||
# Node
|
||||
node_modules
|
||||
npm-debug.log
|
||||
yarn-error.log
|
||||
package-lock.json
|
||||
|
||||
# Ruby
|
||||
.direnv
|
||||
|
||||
# Emacs
|
||||
*~
|
||||
|
||||
# Vim
|
||||
.*.swp
|
||||
.*.swo
|
||||
.*.swn
|
||||
.*.swm
|
||||
|
||||
# Sublime Text
|
||||
*.sublime-project
|
||||
*.sublime-workspace
|
||||
|
||||
# Xcode
|
||||
*.pbxuser
|
||||
!default.pbxuser
|
||||
*.xccheckout
|
||||
*.xcscmblueprint
|
||||
xcuserdata
|
||||
|
||||
# Android Studio
|
||||
*.iml
|
||||
.gradle
|
||||
.idea/libraries
|
||||
.idea/workspace.xml
|
||||
.idea/gradle.xml
|
||||
.idea/misc.xml
|
||||
.idea/modules.xml
|
||||
.idea/vcs.xml
|
||||
|
||||
# Eclipse
|
||||
.project
|
||||
.settings
|
||||
|
||||
# VSCode
|
||||
.history/
|
||||
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"printWidth": 120,
|
||||
"tabWidth": 2,
|
||||
"singleQuote": true,
|
||||
"bracketSameLine": true,
|
||||
"trailingComma": "es5",
|
||||
"arrowParens": "avoid",
|
||||
"endOfLine": "auto"
|
||||
}
|
||||
@@ -0,0 +1,43 @@
|
||||
const rules = [
|
||||
{ type: 'feat', release: 'minor', title: 'New features' },
|
||||
{ type: 'feature', release: 'minor', title: 'New features' },
|
||||
{ type: 'fix', release: 'patch', title: 'Bug fixes' },
|
||||
{ type: 'refactor', release: 'patch', title: 'Code changes' },
|
||||
{ type: 'chore', release: 'patch', title: 'Other chores' },
|
||||
{ type: 'docs', release: 'patch', title: 'Documentation changes' },
|
||||
];
|
||||
|
||||
// Simple mapping to order the commit groups
|
||||
const sortMap = Object.fromEntries(rules.map((rule, index) => [rule.title, index]));
|
||||
|
||||
module.exports = {
|
||||
branches: ['main'],
|
||||
tagFormat: '${version}',
|
||||
plugins: [
|
||||
['@semantic-release/commit-analyzer', {
|
||||
preset: 'conventionalcommits',
|
||||
releaseRules: [
|
||||
{ breaking: true, release: 'major' },
|
||||
{ revert: true, release: 'patch' },
|
||||
].concat(
|
||||
rules.map(({ type, release, breaking }) => ({ type, release, breaking }))
|
||||
),
|
||||
}],
|
||||
['@semantic-release/release-notes-generator', {
|
||||
preset: 'conventionalcommits',
|
||||
presetConfig: {
|
||||
types: rules.map(({ type, title }) => ({ type, section: title })),
|
||||
},
|
||||
writerOpts: {
|
||||
commitGroupsSort: (a, z) => sortMap[a.title] - sortMap[z.title],
|
||||
},
|
||||
}],
|
||||
'@semantic-release/changelog',
|
||||
['@semantic-release/npm', { npmPublish: false }],
|
||||
['@semantic-release/git', {
|
||||
message: 'chore: create new release ${nextRelease.version}\n\n${nextRelease.notes}',
|
||||
assets: ['package.json', 'CHANGELOG.md'],
|
||||
}],
|
||||
'@semantic-release/github',
|
||||
],
|
||||
};
|
||||
@@ -0,0 +1,11 @@
|
||||
{
|
||||
"jsc": {
|
||||
"target": "es2020",
|
||||
"parser": {
|
||||
"syntax": "typescript"
|
||||
}
|
||||
},
|
||||
"module": {
|
||||
"type": "commonjs"
|
||||
}
|
||||
}
|
||||
-19
@@ -1,19 +0,0 @@
|
||||
---
|
||||
language: bash
|
||||
services:
|
||||
- docker
|
||||
env:
|
||||
global:
|
||||
- DOCKER_IMAGE=bycedric/expo-cli
|
||||
- DOCKER_TAG=2
|
||||
script:
|
||||
- docker build base -t $DOCKER_IMAGE:$DOCKER_TAG
|
||||
- docker run -ti --rm $DOCKER_IMAGE:$DOCKER_TAG diagnostics
|
||||
before_deploy:
|
||||
- echo "$DOCKER_PASSWORD" | docker login -u "$DOCKER_USERNAME" --password-stdin
|
||||
- docker tag $DOCKER_IMAGE:$DOCKER_TAG $DOCKER_IMAGE:latest
|
||||
deploy:
|
||||
provider: script
|
||||
script: docker push $DOCKER_IMAGE:$DOCKER_TAG && docker push $DOCKER_IMAGE:latest
|
||||
on:
|
||||
branch: master
|
||||
+257
@@ -1,3 +1,260 @@
|
||||
## [6.0.0](https://github.com/expo/expo-github-action/compare/5.5.1...6.0.0) (2021-06-22)
|
||||
|
||||
|
||||
### ⚠ BREAKING CHANGES
|
||||
|
||||
* GitHub Action inputs are changed to allow both Expo and EAS CLI.
|
||||
|
||||
### New features
|
||||
|
||||
* add support for eas cli installs ([#98](https://github.com/expo/expo-github-action/issues/98)) ([04692c3](https://github.com/expo/expo-github-action/commit/04692c3cb1f7ad977f62841ca0bb175c903f653f))
|
||||
|
||||
|
||||
### Other chores
|
||||
|
||||
* update node to 14 and 16 in ci ([#100](https://github.com/expo/expo-github-action/issues/100)) ([a03876e](https://github.com/expo/expo-github-action/commit/a03876e3c556bea147f2be007eac911bf78c9b23))
|
||||
|
||||
|
||||
### Documentation changes
|
||||
|
||||
* add commands to contirbuting guide for updating v{major} tags ([1b57c37](https://github.com/expo/expo-github-action/commit/1b57c37e9bdfe92e183befb3595debc64da672f0))
|
||||
* update readme for v6 release ([#101](https://github.com/expo/expo-github-action/issues/101)) ([8b43bae](https://github.com/expo/expo-github-action/commit/8b43bae073f280d4fa76aa174642ad46febe985c))
|
||||
* update upstream reference in contributing guide ([76ce4de](https://github.com/expo/expo-github-action/commit/76ce4de80ea89b343404cdabadc922882af80487))
|
||||
|
||||
### [5.5.1](https://github.com/expo/expo-github-action/compare/5.5.0...5.5.1) (2021-06-17)
|
||||
|
||||
|
||||
### Bug fixes
|
||||
|
||||
* revert to node 12 for the action ([2662a5f](https://github.com/expo/expo-github-action/commit/2662a5f0dec42d7a9c66b55f8ce937f37aaac9b4))
|
||||
|
||||
## [5.5.0](https://github.com/expo/expo-github-action/compare/5.4.0...5.5.0) (2021-06-17)
|
||||
|
||||
|
||||
### New features
|
||||
|
||||
* switch to node 14 for the action itself ([f13b0ea](https://github.com/expo/expo-github-action/commit/f13b0ea032efcf2e6689743879af6b3e1c72201d))
|
||||
|
||||
|
||||
### Bug fixes
|
||||
|
||||
* add support for environments without remote cache ([#91](https://github.com/expo/expo-github-action/issues/91)) ([9c0e696](https://github.com/expo/expo-github-action/commit/9c0e6962510d4e08c6429cac42f624c563675ee1))
|
||||
|
||||
|
||||
### Code changes
|
||||
|
||||
* simplify typescript config with community config ([#94](https://github.com/expo/expo-github-action/issues/94)) ([da4e754](https://github.com/expo/expo-github-action/commit/da4e75428b7c5ffd16e8b2c698f590313c741621))
|
||||
* update all dependencies to latest versions ([#93](https://github.com/expo/expo-github-action/issues/93)) ([6bc0bed](https://github.com/expo/expo-github-action/commit/6bc0bedbc75bb0d6743e4accf032cd01348d6775))
|
||||
|
||||
|
||||
### Other chores
|
||||
|
||||
* add semantic release for easy versioning ([#95](https://github.com/expo/expo-github-action/issues/95)) ([6354b0a](https://github.com/expo/expo-github-action/commit/6354b0a0477a72375cee808d8a5b6006d6e86e77))
|
||||
* fix the allowed branches for semenatic release ([6b8c488](https://github.com/expo/expo-github-action/commit/6b8c488fd6239c9a76d7f95355a58bc8b2a20ac4))
|
||||
* mock the github actions warning to avoid leaking annotations ([#96](https://github.com/expo/expo-github-action/issues/96)) ([a11a47a](https://github.com/expo/expo-github-action/commit/a11a47a3e8735a206eed196499604322b0bdc877))
|
||||
* tweak the release workflow ([79ebfbc](https://github.com/expo/expo-github-action/commit/79ebfbc3b83497f443fd65eb5bd33484e5519f64))
|
||||
|
||||
|
||||
### Documentation changes
|
||||
|
||||
* add missing release step to contributing guide ([04e3b32](https://github.com/expo/expo-github-action/commit/04e3b32e94e3abe9cd65d37c57a0cead55186970))
|
||||
|
||||
## [5.4.0](https://github.com/expo/expo-github-action/compare/5.3.1...5.4.0) (2021-01-12)
|
||||
|
||||
### New features
|
||||
|
||||
* improve error handling with update check ([#76](https://github.com/expo/expo-github-action/pull/76)) ([917e072](https://github.com/expo/expo-github-action/commit/917e072))
|
||||
|
||||
### Code refactors
|
||||
|
||||
* use official actions cache package instead of cypress fork ([#62](https://github.com/expo/expo-github-action/pull/62)) ([0eb46e9](https://github.com/expo/expo-github-action/commit/0eb46e9))
|
||||
* output cache errors with actions core ([187c4ad](https://github.com/expo/expo-github-action/commit/187c4ad))
|
||||
* group output by steps for readability ([#70](https://github.com/expo/expo-github-action/pull/70)) ([75b743c](https://github.com/expo/expo-github-action/commit/75b743c))
|
||||
* update all dev dependencies to latest version ([#71](https://github.com/expo/expo-github-action/pull/71)) ([ed7f67d](https://github.com/expo/expo-github-action/commit/ed7f67d))
|
||||
|
||||
### Documentation changes
|
||||
|
||||
* update the cache description without the fork ([13d7820](https://github.com/expo/expo-github-action/commit/13d7820))
|
||||
* update readme to latest expo cli and node ([#77](https://github.com/expo/expo-github-action/pull/77)) ([6c0f4d7](https://github.com/expo/expo-github-action/commit/6c0f4d7))
|
||||
|
||||
### Other chores
|
||||
|
||||
* update all dependencies to latest versions ([#78](https://github.com/expo/expo-github-action/pull/78)) ([4ec7251](https://github.com/expo/expo-github-action/commit/4ec7251))
|
||||
|
||||
|
||||
## [5.3.1](https://github.com/expo/expo-github-action/compare/5.3.0...5.3.1) (2020-10-20)
|
||||
|
||||
### Other chores
|
||||
|
||||
* bump @actions/core from 1.2.4 to 1.2.6 ([#63](https://github.com/expo/expo-github-action/pull/63)) ([b807fa6](https://github.com/expo/expo-github-action/commit/b807fa6))
|
||||
|
||||
|
||||
## [5.3.0](https://github.com/expo/expo-github-action/compare/5.2.0...5.3.0) (2020-09-19)
|
||||
|
||||
### New features
|
||||
|
||||
* add expo token authentication method ([#57](https://github.com/expo/expo-github-action/pull/57)) ([1c36889](https://github.com/expo/expo-github-action/commit/1c36889))
|
||||
|
||||
|
||||
## [5.2.0](https://github.com/expo/expo-github-action/compare/5.1.1...5.2.0) (2020-07-14)
|
||||
|
||||
### Bug fixes
|
||||
|
||||
* proper space between icon and text ([#50](https://github.com/expo/expo-github-action/pull/50)) ([b8a49f4](https://github.com/expo/expo-github-action/commit/b8a49f4))
|
||||
|
||||
### Code refactors
|
||||
|
||||
* use github actions instead of circle ([#54](https://github.com/expo/expo-github-action/pull/54)) ([d3602b9](https://github.com/expo/expo-github-action/commit/d3602b9))
|
||||
|
||||
### Documentation changes
|
||||
|
||||
* fix grammar and link in readme ([#53](https://github.com/expo/expo-github-action/pull/53)) ([6ac67f0](https://github.com/expo/expo-github-action/commit/6ac67f0))
|
||||
* update build badge in readme ([#56](https://github.com/expo/expo-github-action/pull/56)) ([050b701](https://github.com/expo/expo-github-action/commit/050b701))
|
||||
|
||||
### Other chores
|
||||
|
||||
* upgrade all dependencies to latest version ([#55](https://github.com/expo/expo-github-action/pull/55)) ([404bd09](https://github.com/expo/expo-github-action/commit/404bd09))
|
||||
|
||||
|
||||
## [5.1.1](https://github.com/expo/expo-github-action/compare/5.1.0...5.1.1) (2020-06-10)
|
||||
|
||||
### Bug fixes
|
||||
|
||||
* use inputs metadata key ([#49](https://github.com/expo/expo-github-action/pull/49)) ([71dfeab](https://github.com/expo/expo-github-action/commit/71dfeab))
|
||||
|
||||
|
||||
## [5.1.0](https://github.com/expo/expo-github-action/compare/5.0.0...5.1.0) (2020-05-08)
|
||||
|
||||
### New features
|
||||
|
||||
* fail when provided credentials are incorrect ([#43](https://github.com/expo/expo-github-action/pull/43)) ([a7b6ce4](https://github.com/expo/expo-github-action/commit/a7b6ce4))
|
||||
|
||||
### Bug fixes
|
||||
|
||||
* remove custom and add global error handling ([#46](https://github.com/expo/expo-github-action/pull/46)) ([a4955da](https://github.com/expo/expo-github-action/commit/a4955da))
|
||||
|
||||
### Test changes
|
||||
|
||||
* check if build is up to date ([#45](https://github.com/expo/expo-github-action/pull/45)) ([cb49096](https://github.com/expo/expo-github-action/commit/cb49096))
|
||||
* add missing cache unit tests ([#44](https://github.com/expo/expo-github-action/pull/44)) ([4279327](https://github.com/expo/expo-github-action/commit/4279327))
|
||||
|
||||
### Other chores
|
||||
|
||||
* update dependencies and configuration ([#42](https://github.com/expo/expo-github-action/pull/42)) ([32b5f9c](https://github.com/expo/expo-github-action/commit/32b5f9c))
|
||||
* **deps**: bump acorn from 5.7.3 to 5.7.4 ([#37](https://github.com/expo/expo-github-action/pull/37)) ([4aaf05f](https://github.com/expo/expo-github-action/commit/4aaf05f))
|
||||
|
||||
|
||||
## [5.0.0](https://github.com/expo/expo-github-action/compare/4.1.0...5.0.0) (2019-12-31)
|
||||
|
||||
### BREAKING CHANGES
|
||||
|
||||
* use yarn by default instead of npm ([#32](https://github.com/expo/expo-github-action/pull/32)) ([2de5b8c3](https://github.com/expo/expo-github-action/commit/2de5b8c))
|
||||
* use ncc to compile scripts ([#31](https://github.com/expo/expo-github-action/pull/31)) ([48288d58](https://github.com/expo/expo-github-action/commit/48288d5))
|
||||
|
||||
### New features
|
||||
|
||||
* implement caching using github actions cache ([#35](https://github.com/expo/expo-github-action/pull/35)) ([69801f0a](https://github.com/expo/expo-github-action/commit/69801f0))
|
||||
|
||||
### Code refactors
|
||||
|
||||
* move index code to run ([#33](https://github.com/expo/expo-github-action/pull/33)) ([f80ef1f6](https://github.com/expo/expo-github-action/commit/f80ef1f))
|
||||
* use yarn by default instead of npm ([#32](https://github.com/expo/expo-github-action/pull/32)) ([2de5b8c3](https://github.com/expo/expo-github-action/commit/2de5b8c))
|
||||
* use ncc to compile scripts ([#31](https://github.com/expo/expo-github-action/pull/31)) ([48288d58](https://github.com/expo/expo-github-action/commit/48288d5))
|
||||
* make logs more visible ([#30](https://github.com/expo/expo-github-action/pull/30)) ([12f58a21](https://github.com/expo/expo-github-action/commit/12f58a2))
|
||||
* update all dependencies to latest versions ([#29](https://github.com/expo/expo-github-action/pull/29)) ([7776e33f](https://github.com/expo/expo-github-action/commit/7776e33))
|
||||
* use circleci instead of github actions ([#28](https://github.com/expo/expo-github-action/pull/28)) ([e5677e1f](https://github.com/expo/expo-github-action/commit/e5677e1))
|
||||
|
||||
### Documentation changes
|
||||
|
||||
* update the default packager value in action ([#34](https://github.com/expo/expo-github-action/pull/34)) ([3ac4a96c](https://github.com/expo/expo-github-action/commit/3ac4a96))
|
||||
|
||||
### Other chores
|
||||
|
||||
* **deps**: bump handlebars from 4.2.0 to 4.5.3 ([#27](https://github.com/expo/expo-github-action/pull/27)) ([4aa2c230](https://github.com/expo/expo-github-action/commit/4aa2c23))
|
||||
|
||||
|
||||
## [4.1.0](https://github.com/expo/expo-github-action/compare/4.0.1...4.1.0) (2019-10-30)
|
||||
|
||||
### Bug fixes
|
||||
|
||||
* use cmd suffix when authenticating on windows ([831bcb1](https://github.com/expo/expo-github-action/commit/831bcb1))
|
||||
|
||||
### Documentation changes
|
||||
|
||||
* remove beta warning just before general availability ([68a2de0](https://github.com/expo/expo-github-action/commit/68a2de0))
|
||||
|
||||
### Other chores
|
||||
|
||||
* update all dependencies to latest version ([16d4b15](https://github.com/expo/expo-github-action/commit/16d4b15))
|
||||
* enable workflow for pull requests ([8ff07e0](https://github.com/expo/expo-github-action/commit/8ff07e0))
|
||||
|
||||
|
||||
## [4.0.0](https://github.com/expo/expo-github-action/compare/3.0.0...4.0.0) (2019-09-29)
|
||||
|
||||
### New features
|
||||
|
||||
* add github workflow for ci ([929a76c](https://github.com/expo/expo-github-action/commit/929a76c))
|
||||
* add new expo action cli install concept ([98b1bea](https://github.com/expo/expo-github-action/commit/98b1bea))
|
||||
* use new action metadata format ([81344e4](https://github.com/expo/expo-github-action/commit/81344e4))
|
||||
|
||||
### Bug fixes
|
||||
|
||||
* add build and node node modules before commit ([00692c4](https://github.com/expo/expo-github-action/commit/00692c4))
|
||||
* add build and node node modules in husky hook ([b2929e3](https://github.com/expo/expo-github-action/commit/b2929e3))
|
||||
|
||||
### Code refactors
|
||||
|
||||
* remove travis config and base images ([e72ddd8](https://github.com/expo/expo-github-action/commit/e72ddd8))
|
||||
* move entry point to expo as proxy ([caf499b](https://github.com/expo/expo-github-action/commit/caf499b))
|
||||
* update proxy for non-interactive mode and help links ([5cfaee2](https://github.com/expo/expo-github-action/commit/5cfaee2))
|
||||
|
||||
### Documentation changes
|
||||
|
||||
* update documentation for the new action ([38e963b](https://github.com/expo/expo-github-action/commit/38e963b))
|
||||
* simplify and link the environment variables info ([26c734a](https://github.com/expo/expo-github-action/commit/26c734a))
|
||||
* replace aliased email with normal email ([f3bc71a](https://github.com/expo/expo-github-action/commit/f3bc71a))
|
||||
* write about entry point proxy and restructure for easy access ([4766fa8](https://github.com/expo/expo-github-action/commit/4766fa8))
|
||||
* update license dates ([89005bc](https://github.com/expo/expo-github-action/commit/89005bc))
|
||||
|
||||
### Other chores
|
||||
|
||||
* add linter and fix all files ([04cd479](https://github.com/expo/expo-github-action/commit/04cd479))
|
||||
* add husky for repository deployments ([cec6e50](https://github.com/expo/expo-github-action/commit/cec6e50))
|
||||
* add all missing tests ([22df52e](https://github.com/expo/expo-github-action/commit/22df52e))
|
||||
|
||||
|
||||
## [3.0.0](https://github.com/expo/expo-github-action/compare/2.3.2...3.0.0) (2019-07-23)
|
||||
|
||||
## Code refactors
|
||||
|
||||
* run travis in parallel for expo cli v2 and v3 ([882d5f9](https://github.com/expo/expo-github-action/commit/882d5f9))
|
||||
* add latest expo-cli v3 but keep v2 images updated ([cd33736](https://github.com/expo/expo-github-action/commit/cd33736))
|
||||
|
||||
|
||||
## [2.3.2](https://github.com/expo/expo-github-action/compare/2.3.1...2.3.2) (2019-05-09)
|
||||
|
||||
### Bug fixes
|
||||
|
||||
* use yarn to install expo cli globally ([9fd3635](https://github.com/expo/expo-github-action/commit/9fd3635))
|
||||
|
||||
|
||||
## [2.3.1](https://github.com/expo/expo-github-action/compare/2.3.0...2.3.1) (2019-04-17)
|
||||
|
||||
### Bug fixes
|
||||
|
||||
* increase node memory limit to 4gb ([4c25ef9](https://github.com/expo/expo-github-action/commit/4c25ef9))
|
||||
|
||||
### Documentation changes
|
||||
|
||||
* add note about overwriting node options ([aa752f2](https://github.com/expo/expo-github-action/commit/aa752f2))
|
||||
* add extra link to base image in description ([fa42241](https://github.com/expo/expo-github-action/commit/fa42241))
|
||||
* rename build action to remove ambiguity with other examples ([92beb0f](https://github.com/expo/expo-github-action/commit/92beb0f))
|
||||
|
||||
### Other chores
|
||||
|
||||
* make travis build the action to double check the docker file ([698a1c6](https://github.com/expo/expo-github-action/commit/698a1c6))
|
||||
|
||||
|
||||
## [2.3.0](https://github.com/expo/expo-github-action/compare/2.2.0...2.3.0) (2019-04-14)
|
||||
|
||||
### New features
|
||||
|
||||
@@ -0,0 +1,57 @@
|
||||
# Contributing to Expo GitHub Action
|
||||
|
||||
## 📦 Download and Setup
|
||||
|
||||
1. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) it to your local device. (`git remote add upstream [email protected]:expo/expo-github-action.git` 😉)
|
||||
2. Make sure you have the following packages globally installed on your system:
|
||||
- [node](https://nodejs.org/) (active Node LTS or higher is recommended)
|
||||
- [yarn](https://yarnpkg.com/)
|
||||
3. Install the Node packages (`yarn install`)
|
||||
|
||||
## 🏎️ Running a custom version
|
||||
|
||||
To try out your changed with GitHub Action, you have [to reference your fork and/or branch or commit reference](https://docs.github.com/en/actions/learn-github-actions/finding-and-customizing-actions#using-release-management-for-your-custom-actions) in the workflow you want to try. After that, you have two options:
|
||||
|
||||
1. Run the workflow in GitHub Actions itself by triggering your workflow.
|
||||
2. Run the workflow locally with [nektos/act](https://github.com/nektos/act).
|
||||
|
||||
## ✅ Testing
|
||||
|
||||
Testing is done using [Jest](https://jestjs.io/https://jestjs.io/). Run `yarn test` to run Jest.
|
||||
|
||||
In CI we are running tests on multiple Node versions using Windows, Linux, and MacOS. Make sure they are passing for your PR.
|
||||
|
||||
## 📝 Writing a Commit Message
|
||||
|
||||
> If this is your first time committing to a large public repo, you could look through this neat tutorial: ["How to Write a Git Commit Message"](https://chris.beams.io/posts/git-commit/)
|
||||
|
||||
Commit messages are formatted using the [Conventional Commits](https://www.conventionalcommits.org/) format. You can take a look at [`.releaserc.js`](./.releaserc.js) for the allowed commit types.
|
||||
|
||||
```
|
||||
docs: fix typo in xxx
|
||||
feature: add support for SDK 40
|
||||
chore: add test-case for custom completions
|
||||
fix: improve logging for errors
|
||||
refactor: update loading icon
|
||||
```
|
||||
|
||||
## 🔎 Before Submitting a PR
|
||||
|
||||
To get your PR merged as fast as possible, please make sure you have done the following:
|
||||
|
||||
- Run `yarn lint --fix` to fix the formatting of the code. Ensure that `yarn lint` succeeds without errors or warnings.
|
||||
- Run `yarn test` to make sure all normal use cases are passing.
|
||||
- Run `yarn build` to ensure the build is up-to-date and runs correctly and without errors or warnings.
|
||||
|
||||
## 🚀 Releasing a new version
|
||||
|
||||
To release a new version for GitHub Actions, we have to create a new release in GitHub. You can run the `Release` workflow to generate a new version, changelog, and GitHub release.
|
||||
|
||||
After the exact version tag is created, update the `v{major}` tag to the latest major version. Make sure you are on the default branch at the commit of versioning.
|
||||
|
||||
```bash
|
||||
$ git checkout main
|
||||
$ git fetch --tags && git pull
|
||||
$ git tag --force v{major}
|
||||
$ git push --force --tags
|
||||
```
|
||||
-10
@@ -1,10 +0,0 @@
|
||||
FROM bycedric/expo-cli:2
|
||||
|
||||
LABEL com.github.actions.name="Expo CLI"
|
||||
LABEL com.github.actions.description="Use any Expo CLI command in your GitHub Actions workflow."
|
||||
LABEL com.github.actions.icon="terminal"
|
||||
LABEL com.github.actions.color="gray-dark"
|
||||
|
||||
COPY entrypoint.sh LICENSE.md README.md /
|
||||
|
||||
entrypoint ["/entrypoint.sh"]
|
||||
+2
-1
@@ -1,6 +1,7 @@
|
||||
# The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2019 Cedric van Putten <me@bycedric.com>
|
||||
Copyright (c) 2019-present Cedric van Putten <me@bycedric.com>
|
||||
|
||||
Copyright (c) 2019-present 650 Industries, Inc. (aka Expo)
|
||||
|
||||
> Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
|
||||
@@ -1,156 +1,322 @@
|
||||
# Expo for GitHub Actions
|
||||
|
||||
> GitHub Actions is still in beta, use it at your own risk.
|
||||
|
||||
Publish, build or manage your [Expo][link-expo] Project with GitHub Actions!
|
||||
This repository contains a prebuilt base image with GitHub Actions implementations.
|
||||
You can also use [the base image](base) in other Docker-based environments.
|
||||
<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/release/expo/expo-github-action/all.svg?style=flat-square" 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/CI/main.svg?style=flat-square" 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?style=flat-square" alt="license" />
|
||||
</a>
|
||||
</p>
|
||||
<p align="center">
|
||||
<a href="https://github.com/expo/expo-github-action#configuration-options"><b>Usage</b></a>
|
||||
—
|
||||
<a href="https://github.com/expo/expo-github-action#example-workflows"><b>Examples</b></a>
|
||||
—
|
||||
<a href="https://github.com/expo/expo-github-action#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>
|
||||
|
||||
## What's inside?
|
||||
|
||||
Within this Expo CLI action, you have full access to the original [Expo CLI][link-expo-cli].
|
||||
That means you are able to perform any command like login, publish and build.
|
||||
Also, this action will authenticate automatically when both `EXPO_CLI_USERNAME` and `EXPO_CLI_PASSWORD` variables are defined.
|
||||
With this Expo action, you have full access to [Expo CLI][link-expo-cli] and [EAS CLI][link-eas-cli] itself.
|
||||
It allows you to fully automate the `expo publish` or `expo build` process, leaving you with more time available for your project.
|
||||
There are some additional features included to make the usage of this action as simple as possible, like caching and authentication.
|
||||
|
||||
> You don't necessarily need this action to use Expo.
|
||||
> You can also add `expo-cli` as a dependency to your project and use the official [NPM action][link-actions-npm] for example.
|
||||
> However, when you do that you need to manage authentication yourself.
|
||||
## Configuration options
|
||||
|
||||
### Why use a base-image?
|
||||
This action is customizable through variables; they are defined in the [`action.yml`](action.yml).
|
||||
Here is a summary of all the variables that you can use and their purpose.
|
||||
|
||||
Every GitHub action will start from scratch, using the dockerfile as the starting point.
|
||||
If you define `expo-cli` in this dockerfile, it will install it every time you run an action.
|
||||
By using a prebuilt image, it basically "skips" the process of downloading the full CLI over and over again.
|
||||
This makes the Expo actions overall faster.
|
||||
| variable | default | description |
|
||||
| ---------------- | ------- | ------------------------------------------------------------------------------------------------------------ |
|
||||
| `expo-version` | - | [Expo CLI](https://github.com/expo/expo-cli) version to install, skips when omitted. |
|
||||
| `expo-cache` | `false` | If it should use the [GitHub actions (remote) cache](#using-the-built-in-cache). |
|
||||
| `expo-cache-key` | - | An optional custom (remote) cache key. _(**use with caution**)_ |
|
||||
| `eas-version` | - | [EAS CLI](https://github.com/expo/eas-cli) version to install, skips when omitted. (`latest` is recommended) |
|
||||
| `eas-cache` | `false` | If it should use the [GitHub actions (remote) cache](#using-the-built-in-cache). |
|
||||
| `eas-cache-key` | - | An optional custom (remote) cache key. _(**use with caution**)_ |
|
||||
| `packager` | `yarn` | The package manager to use. _(e.g. `npm`)_ |
|
||||
| `token` | - | The token of your Expo account _(e.g. [`${{ secrets.EXPO_TOKEN }}`][link-actions-secrets])_ |
|
||||
| `username` | - | The username of your Expo account _(e.g. `bycedric`)_ |
|
||||
| `password` | - | The password of your Expo account _(e.g. [`${{ secrets.EXPO_CLI_PASSWORD }}`][link-actions-secrets])_ |
|
||||
| `patch-watchers` | `true` | If it should [patch the `fs.inotify.` limits](#enospc-errors-on-linux). |
|
||||
|
||||
### Used secrets
|
||||
> Never hardcode `expo-token` or `expo-password` in your workflow, use [secrets][link-actions-secrets] to store them.
|
||||
|
||||
To authenticate with your Expo account, use the variables listed below.
|
||||
In the Expo action you can define `secrets = ["EXPO_CLI_USERNAME", "EXPO_CLI_PASSWORD"]` to have them available.
|
||||
|
||||
variable | description
|
||||
--- | ---
|
||||
`EXPO_CLI_USERNAME` | The email address or username of your Expo account.
|
||||
`EXPO_CLI_PASSWORD` | The password of your Expo account, [automatically picked up by the cli][link-expo-cli-password].
|
||||
|
||||
> Some Expo commands don't require authentication.
|
||||
> Simply omit the `secrets = [...]` if you don't need it.
|
||||
> Using `latest` for `eas-version` is recommened, you should always have the latest version of this CLI installed.
|
||||
|
||||
## Example workflows
|
||||
|
||||
Before you dive into the workflow examples, you should know the basics of GitHub Actions.
|
||||
You can read more about this in the [GitHub Actions documentation][link-actions].
|
||||
|
||||
1. [Publish on any push](#publish-on-any-push)
|
||||
2. [Publish on a specific branch](#publish-on-a-specific-branch)
|
||||
3. [Test and build web every day at 08:00](#test-and-build-web-every-day-at-0800)
|
||||
1. [Publish on any push to main](#publish-on-any-push-to-main)
|
||||
2. [Cache Expo CLI for other jobs](#cache-expo-cli-for-other-jobs)
|
||||
3. [Creating a new EAS build](#creating-a-new-eas-build)
|
||||
4. [Test PRs and publish a review version](#test-prs-and-publish-a-review-version)
|
||||
5. [Test PRs on multiple nodes and systems](#test-prs-on-multiple-nodes-and-systems)
|
||||
6. [Test and build web every day at 08:00](#test-and-build-web-every-day-at-0800)
|
||||
7. [Authenticate using credentials](#authenticate-using-credentials)
|
||||
|
||||
### Publish on any push
|
||||
### Publish on any push to main
|
||||
|
||||
Below you can see the example configuration to publish whenever the repository is updated.
|
||||
The workflow listens to the `push` event and resolves directly to the `publish` action.
|
||||
Before publishing your app, it installs your project's dependencies using the [NPM action][link-actions-npm].
|
||||
Below you can see the example configuration to publish whenever the main branch is updated.
|
||||
The workflow listens to the `push` event and sets up Node 14 using the [Setup Node Action][link-actions-node].
|
||||
It also auto-authenticates when the `token` is provided.
|
||||
|
||||
```hcl
|
||||
workflow "Install and Publish" {
|
||||
on = "push"
|
||||
resolves = ["Publish"]
|
||||
}
|
||||
|
||||
action "Install" {
|
||||
uses = "actions/npm@master"
|
||||
args = "install"
|
||||
}
|
||||
|
||||
action "Publish" {
|
||||
needs = "Install"
|
||||
uses = "expo/[email protected]"
|
||||
args = "publish"
|
||||
secrets = ["EXPO_CLI_USERNAME", "EXPO_CLI_PASSWORD"]
|
||||
}
|
||||
```yml
|
||||
name: Expo Publish
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
jobs:
|
||||
publish:
|
||||
name: Install and publish
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions/setup-node@v2
|
||||
with:
|
||||
node-version: 14.x
|
||||
- uses: expo/expo-github-action@v6
|
||||
with:
|
||||
expo-version: 4.x
|
||||
token: ${{ secrets.EXPO_TOKEN }}
|
||||
- run: yarn install
|
||||
- run: expo publish
|
||||
```
|
||||
|
||||
### Publish on a specific branch
|
||||
### Cache Expo CLI for other jobs
|
||||
|
||||
This workflow is similar to the [publish on any push](#publish-on-any-push) configuration.
|
||||
It will install and test the code using the [NPM action][link-actions-npm] on every push.
|
||||
But instead of publishing on any push too, it will publish on the `master` branch only.
|
||||
Below you can see a slightly modified version of the example above.
|
||||
In this one, we enabled the built-in cache that will reuse a previously installed Expo CLI.
|
||||
It skips the installation part and extracts the files directly, boosting the performance of your workflow.
|
||||
|
||||
```hcl
|
||||
workflow "Install and Publish" {
|
||||
on = "push"
|
||||
resolves = ["Publish"]
|
||||
}
|
||||
> You can [read more about the cache here](#using-the-built-in-cache)
|
||||
|
||||
action "Install" {
|
||||
uses = "actions/npm@master"
|
||||
args = "install"
|
||||
}
|
||||
```yml
|
||||
name: Expo Publish
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
jobs:
|
||||
publish:
|
||||
name: Install and publish
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions/setup-node@v2
|
||||
with:
|
||||
node-version: 14.x
|
||||
- uses: expo/expo-github-action@v6
|
||||
with:
|
||||
expo-version: 4.x
|
||||
expo-cache: true
|
||||
token: ${{ secrets.EXPO_TOKEN }}
|
||||
- run: yarn install
|
||||
- run: expo publish
|
||||
```
|
||||
|
||||
action "Test" {
|
||||
needs = "Install"
|
||||
uses = "actions/npm@master"
|
||||
args = "test"
|
||||
}
|
||||
### Creating a new EAS build
|
||||
|
||||
action "Filter branch" {
|
||||
needs = "Test"
|
||||
uses = "actions/bin/filter@master"
|
||||
args = "branch master"
|
||||
}
|
||||
You can also install [EAS](https://docs.expo.dev/eas/) CLI with this GitHub Action.
|
||||
Below we've swapped `expo-version` with `eas-version`, but you can also use them together.
|
||||
Both the `token` and `username`/`password` is shared between both Expo and EAS CLI.
|
||||
|
||||
action "Publish" {
|
||||
needs = "Filter branch"
|
||||
uses = "expo/[email protected]"
|
||||
args = "publish"
|
||||
secrets = ["EXPO_CLI_USERNAME", "EXPO_CLI_PASSWORD"]
|
||||
}
|
||||
> We recommend using `latest` for `eas-version` to always have the most up-to-date version.
|
||||
|
||||
```yml
|
||||
name: EAS build
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
jobs:
|
||||
build:
|
||||
name: Create new build
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions/setup-node@v2
|
||||
with:
|
||||
node-version: 14.x
|
||||
- uses: expo/expo-github-action@v6
|
||||
with:
|
||||
eas-version: latest
|
||||
token: ${{ secrets.EXPO_TOKEN }}
|
||||
- run: yarn install
|
||||
- run: eas build
|
||||
```
|
||||
|
||||
### Test PRs and publish a review version
|
||||
|
||||
Reviewing pull requests can take some time if you have to read every line of code.
|
||||
To make this easier, you can publish the edited version of the PR using a [release channel][link-expo-release-channels].
|
||||
Below you can see an example of a workflow that publishes and comments on te PR when the app is published.
|
||||
|
||||
```yml
|
||||
name: Expo Review
|
||||
on: [pull_request]
|
||||
jobs:
|
||||
publish:
|
||||
name: Install and publish
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions/setup-node@v2
|
||||
with:
|
||||
node-version: 14.x
|
||||
- uses: expo/expo-github-action@v6
|
||||
with:
|
||||
expo-version: 4.x
|
||||
token: ${{ secrets.EXPO_TOKEN }}
|
||||
- run: yarn install
|
||||
- run: expo publish --release-channel=pr-${{ github.event.number }}
|
||||
- uses: unsplash/comment-on-pr@master
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
with:
|
||||
msg: App is ready for review, you can [see it here](https://expo.dev/@bycedric/use-expo?release-channel=pr-${{ github.event.number }}).
|
||||
```
|
||||
|
||||
### Test PRs on multiple nodes and systems
|
||||
|
||||
With GitHub Actions, it's reasonably easy to set up a matrix build and test the app on multiple environments.
|
||||
These matrixes can help to make sure your app runs smoothly on a broad set of different development machines.
|
||||
|
||||
> If you don't need automatic authentication, you can omit the `token` variables.
|
||||
|
||||
```yml
|
||||
name: Expo CI
|
||||
on: [pull_request]
|
||||
jobs:
|
||||
ci:
|
||||
name: Continuous Integration
|
||||
runs-on: ${{ matrix.os }}
|
||||
strategy:
|
||||
matrix:
|
||||
os: [ubuntu-latest, macOS-latest, windows-latest]
|
||||
node: [10, 12, 13]
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions/setup-node@v2
|
||||
with:
|
||||
node-version: ${{ matrix.node }}
|
||||
- uses: expo/expo-github-action@v6
|
||||
with:
|
||||
expo-version: 4.x
|
||||
- run: yarn install
|
||||
- run: yarn test
|
||||
- run: expo doctor
|
||||
```
|
||||
|
||||
### Test and build web every day at 08:00
|
||||
|
||||
The most significant change here is that we've changed the workflow trigger.
|
||||
Instead of listening to push events, it's scheduled to run every day at 08:00.
|
||||
You can also schedule jobs by using the cron syntax.
|
||||
It can help to minimize the number of updates your users have to install.
|
||||
|
||||
> For web builds, you don't need to be authenticated.
|
||||
> That's why `secrets = [...]` is omitted here.
|
||||
|
||||
```hcl
|
||||
workflow "Install, Test and Build Web" {
|
||||
on = "schedule(0 8 * * *)"
|
||||
resolves = ["Publish"]
|
||||
}
|
||||
|
||||
action "Install" {
|
||||
uses = "actions/npm@master"
|
||||
args = "install"
|
||||
}
|
||||
|
||||
action "Test" {
|
||||
needs = "Install"
|
||||
uses = "actions/npm@master"
|
||||
args = "test"
|
||||
}
|
||||
|
||||
action "Publish" {
|
||||
needs = "Test"
|
||||
uses = "expo/[email protected]"
|
||||
args = "build:web"
|
||||
}
|
||||
```yml
|
||||
name: Expo Daily CI
|
||||
on:
|
||||
schedule:
|
||||
- cron: 0 8 * * *
|
||||
jobs:
|
||||
ci:
|
||||
name: Daily Continuous Integration
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions/setup-node@v2
|
||||
with:
|
||||
node-version: 14.x
|
||||
- uses: expo/expo-github-action@v6
|
||||
with:
|
||||
expo-version: 4.x
|
||||
- run: yarn install
|
||||
- run: yarn test
|
||||
- run: expo build:web
|
||||
```
|
||||
|
||||
## License
|
||||
### Authenticate using credentials
|
||||
|
||||
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
|
||||
Instead of using an access token, you can also authenticate using credentials.
|
||||
This is only possible when Expo CLI is installed.
|
||||
|
||||
--- ---
|
||||
```yml
|
||||
name: Expo Publish
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
jobs:
|
||||
publish:
|
||||
name: Install and publish
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions/setup-node@v2
|
||||
with:
|
||||
node-version: 14.x
|
||||
- uses: expo/expo-github-action@v6
|
||||
with:
|
||||
expo-version: 4.x
|
||||
username: ${{ secrets.EXPO_CLI_USERNAME }}
|
||||
password: ${{ secrets.EXPO_CLI_PASSWORD }}
|
||||
- run: yarn install
|
||||
- run: expo publish
|
||||
```
|
||||
|
||||
<p align="center">
|
||||
with :heart: <a href="https://bycedric.com" target="_blank">byCedric</a>
|
||||
</p>
|
||||
## Things to know
|
||||
|
||||
[link-actions]: https://developer.github.com/actions/
|
||||
[link-actions-npm]: https://github.com/actions/npm
|
||||
[link-expo]: https://expo.io
|
||||
[link-expo-cli]: https://docs.expo.io/versions/latest/workflow/expo-cli
|
||||
[link-expo-cli-password]: https://github.com/expo/expo-cli/blob/8ea616d8848a123270b97e226e33dcb3dde49653/packages/expo-cli/src/accounts.js#L94
|
||||
### Automatic Expo login
|
||||
|
||||
You need to authenticate for some Expo commands like `expo publish` and `expo build`.
|
||||
This action gives you configuration options to keep your workflow simple.
|
||||
You can choose if you want to authenticate using an `EXPO_TOKEN` or account credentials.
|
||||
Under the hood, it uses the [`EXPO_CLI_PASSWORD`][link-expo-cli-password] environment variable to make credentials authentication as secure as possible.
|
||||
|
||||
> Note, this action only uses your token or credentials to authenticate with Expo. It doesn't store these anywhere.
|
||||
|
||||
### Using the built-in cache
|
||||
|
||||
You can opt-in to caching the installation, making it a lot faster.
|
||||
Under the hood, it uses the [`@action/cache`][link-actions-cache-package] package to restore the Expo CLI installation.
|
||||
This action generates a unique cache key for the OS, used packager, and exact version of the Expo CLI.
|
||||
If you need more control over this cache, you can define a custom cache key with `expo-cache-key`.
|
||||
|
||||
> Note, this cache will count towards your [repo cache limit][link-actions-cache-limit]. The Expo and EAS CLI are stored in different caches.
|
||||
|
||||
### ENOSPC errors on Linux
|
||||
|
||||
When you run `expo publish` or `expo build`, a new bundle is created.
|
||||
Creating these bundles require quite some resources.
|
||||
As of writing, GitHub actions has some small default values for the `fs.inotify` settings.
|
||||
Inside this action, we included a patch that increases these limits for the current workflow.
|
||||
It increases the `max_user_instances`, `max_user_watches` and `max_queued_events` to `524288`.
|
||||
You can disable this patch by setting the `patch-watchers` to `false`.
|
||||
|
||||
<div align="center">
|
||||
<br />
|
||||
with :heart: <strong>byCedric</strong>
|
||||
<br />
|
||||
</div>
|
||||
|
||||
[link-actions]: https://help.github.com/en/categories/automating-your-workflow-with-github-actions
|
||||
[link-actions-cache-limit]: https://github.com/actions/cache#cache-limits
|
||||
[link-actions-cache-package]: https://www.npmjs.com/package/@actions/cache
|
||||
[link-actions-node]: https://github.com/actions/setup-node
|
||||
[link-actions-secrets]: https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets
|
||||
[link-expo-cli]: https://docs.expo.dev/workflow/expo-cli/
|
||||
[link-expo-cli-password]: https://github.com/expo/expo-cli/blob/master/packages/expo-cli/src/accounts.ts#L88-L90
|
||||
[link-expo-release-channels]: https://docs.expo.dev/distribution/release-channels/
|
||||
[link-eas-cli]: https://github.com/expo/eas-cli#readme
|
||||
[link-semver-playground]: https://semver.npmjs.com/
|
||||
+37
@@ -0,0 +1,37 @@
|
||||
---
|
||||
name: Expo GitHub Action
|
||||
author: Cedric van Putten <[email protected]>
|
||||
description: Expo CLI in your GitHub Actions workflow.
|
||||
branding:
|
||||
icon: terminal
|
||||
color: gray-dark
|
||||
runs:
|
||||
using: node16
|
||||
main: build/setup.js
|
||||
inputs:
|
||||
expo-version:
|
||||
description: The Expo CLI version to install (use any semver/dist-tag available).
|
||||
expo-cache:
|
||||
description: If Expo CLI should be stored in the GitHub Actions cache.
|
||||
default: false
|
||||
expo-cache-key:
|
||||
description: A custom remote cache key to use for Expo CLI.
|
||||
eas-version:
|
||||
description: The EAS CLI version to install (use any semver/dist-tag available).
|
||||
eas-cache:
|
||||
description: If EAS CLI should be stored in the GitHub Actions cache.
|
||||
default: false
|
||||
eas-cache-key:
|
||||
description: A custom remote cache key to use for EAS CLI.
|
||||
username:
|
||||
description: Your Expo username, for authentication.
|
||||
token:
|
||||
description: Your Expo token, for authentication. (use with secrets)
|
||||
password:
|
||||
description: Your Expo password, for authentication. (use with secrets)
|
||||
packager:
|
||||
description: The package manager used to install the Expo CLI. (can be yarn or npm)
|
||||
default: yarn
|
||||
patch-watchers:
|
||||
description: If Expo should fix the default watchers limit, helps with ENOSPC errors. (can be true or false)
|
||||
default: true
|
||||
@@ -1,14 +0,0 @@
|
||||
FROM node:10
|
||||
|
||||
LABEL name="Expo for Docker"
|
||||
LABEL repository="https://github.com/expo/expo-github-action"
|
||||
LABEL homepage="https://github.com/expo/expo-github-action/blob/master/base"
|
||||
LABEL maintainer="Cedric van Putten <[email protected]>"
|
||||
|
||||
RUN npm install --global expo-cli@2 \
|
||||
&& npm cache rm --force \
|
||||
&& rm -rf ~/.npm
|
||||
|
||||
COPY entrypoint.sh LICENSE.md README.md /
|
||||
|
||||
ENTRYPOINT ["/entrypoint.sh"]
|
||||
@@ -1,22 +0,0 @@
|
||||
# The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2019 Cedric van Putten <me@bycedric.com>
|
||||
Copyright (c) 2019-present 650 Industries, Inc. (aka Expo)
|
||||
|
||||
> Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
> of this software and associated documentation files (the "Software"), to deal
|
||||
> in the Software without restriction, including without limitation the rights
|
||||
> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
> copies of the Software, and to permit persons to whom the Software is
|
||||
> furnished to do so, subject to the following conditions:
|
||||
>
|
||||
> The above copyright notice and this permission notice shall be included in
|
||||
> all copies or substantial portions of the Software.
|
||||
>
|
||||
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
> THE SOFTWARE.
|
||||
@@ -1,40 +0,0 @@
|
||||
# Expo for Docker
|
||||
|
||||
[](https://travis-ci.com/expo/expo-github-action)
|
||||
|
||||
A prebuilt docker image to use the [Expo CLI][link-expo-cli] on Docker-based environments.
|
||||
This image contains all necessary libraries to perform all commands of the CLI.
|
||||
To make sure this image stays up to date, Travis CI is scheduled to run weekly builds.
|
||||
|
||||
- Based on `node:10` image
|
||||
- Contains globally installed `expo-cli@2`
|
||||
|
||||
## Usage
|
||||
|
||||
The entry point of this image forwards to the Expo CLI itself.
|
||||
With this entry point, you can provide any command directly to Docker.
|
||||
When nothing is provided, it will output the help information provided by the CLI.
|
||||
|
||||
> The entry point uses `sh -c` to invoke Expo, making environment variables available to that command.
|
||||
|
||||
```bash
|
||||
$ docker run --rm bycedric/expo-cli
|
||||
$ docker run --rm bycedric/expo-cli pubish
|
||||
$ docker run --rm -ti bycedric/expo-cli login
|
||||
$ docker run --rm -ti --entrypoint sh bycedric/expo-cli
|
||||
```
|
||||
|
||||
> This image is intended to use on Docker-based CI environments, see [the Expo CI guide][link-expo-cicd] to get started.
|
||||
|
||||
## License
|
||||
|
||||
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
|
||||
|
||||
--- ---
|
||||
|
||||
<p align="center">
|
||||
with :heart: <a href="https://bycedric.com" target="_blank">byCedric</a>
|
||||
</p>
|
||||
|
||||
[link-expo-cli]: https://docs.expo.io/versions/latest/workflow/expo-cli
|
||||
[link-expo-cicd]: https://docs.expo.io/versions/latest/guides/setting-up-continuous-integration
|
||||
@@ -1,4 +0,0 @@
|
||||
#!/bin/sh -l
|
||||
|
||||
set -e
|
||||
sh -c "expo $*"
|
||||
+12574
File diff suppressed because it is too large.
Load diff
@@ -1,11 +0,0 @@
|
||||
#!/bin/sh -l
|
||||
|
||||
set -e
|
||||
|
||||
if [ -n "$EXPO_CLI_USERNAME" ] && [ -n "$EXPO_CLI_PASSWORD" ]; then
|
||||
expo login --username $EXPO_CLI_USERNAME
|
||||
else
|
||||
echo 'Skipping Expo login, username and/or password not defined...'
|
||||
fi
|
||||
|
||||
sh -c "expo $*"
|
||||
@@ -0,0 +1,12 @@
|
||||
/** @type {import('@jest/types').Config.InitialOptions} */
|
||||
module.exports = {
|
||||
verbose: true,
|
||||
clearMocks: true,
|
||||
moduleFileExtensions: ['js', 'ts'],
|
||||
testEnvironment: 'node',
|
||||
testMatch: ['**/*.test.ts'],
|
||||
testRunner: 'jest-circus/runner',
|
||||
transform: {
|
||||
'^.+\\.ts$': 'ts-jest',
|
||||
},
|
||||
};
|
||||
@@ -0,0 +1,55 @@
|
||||
{
|
||||
"private": true,
|
||||
"name": "expo-github-action",
|
||||
"version": "6.0.0",
|
||||
"description": "Expo CLI in your GitHub Actions workflow",
|
||||
"main": "build/index.js",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/expo/expo-github-action.git"
|
||||
},
|
||||
"author": "Cedric van Putten <[email protected]>",
|
||||
"license": "MIT",
|
||||
"bugs": {
|
||||
"url": "https://github.com/expo/expo-github-action/issues"
|
||||
},
|
||||
"homepage": "https://github.com/expo/expo-github-action#readme",
|
||||
"scripts": {
|
||||
"test": "jest",
|
||||
"lint": "tsc --noEmit && eslint .",
|
||||
"build": "spack && rimraf build/*.map",
|
||||
"clean": "rimraf build .swc"
|
||||
},
|
||||
"dependencies": {
|
||||
"@actions/cache": "^1.0.7",
|
||||
"@actions/core": "^1.6.0",
|
||||
"@actions/exec": "^1.1.0",
|
||||
"@actions/io": "^1.1.1",
|
||||
"@actions/tool-cache": "^1.7.1",
|
||||
"semver": "^7.3.5"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@semantic-release/changelog": "^5.0.1",
|
||||
"@semantic-release/git": "^9.0.0",
|
||||
"@swc/cli": "^0.1.55",
|
||||
"@swc/core": "^1.2.128",
|
||||
"@tsconfig/node16": "^1.0.2",
|
||||
"@types/jest": "^27.0.2",
|
||||
"@types/node": "^16.11.19",
|
||||
"@types/semver": "^7.3.6",
|
||||
"@typescript-eslint/eslint-plugin": "^5.4.0",
|
||||
"@typescript-eslint/parser": "^5.4.0",
|
||||
"conventional-changelog-conventionalcommits": "^4.6.0",
|
||||
"eslint": "^8.2.0",
|
||||
"eslint-plugin-jest": "^25.2.4",
|
||||
"eslint-plugin-prettier": "^4.0.0",
|
||||
"jest": "^27.3.1",
|
||||
"jest-circus": "^27.3.1",
|
||||
"prettier": "^2.4.1",
|
||||
"regenerator-runtime": "^0.13.9",
|
||||
"rimraf": "^3.0.2",
|
||||
"semantic-release": "^17.4.4",
|
||||
"ts-jest": "^27.0.7",
|
||||
"typescript": "^4.4.4"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,40 @@
|
||||
const { config } = require('@swc/core/spack');
|
||||
const { readdirSync } = require('fs');
|
||||
const { resolve, basename, extname } = require('path');
|
||||
|
||||
module.exports = config({
|
||||
target: 'node',
|
||||
entry: actions(resolve(__dirname, 'src/actions')),
|
||||
output: {
|
||||
path: resolve(__dirname, 'build'),
|
||||
},
|
||||
externalModules: externals(),
|
||||
});
|
||||
|
||||
/**
|
||||
* Get all action entry points, in src/actions.
|
||||
* This returns them as `{ [name]: absolutePath }`.
|
||||
*/
|
||||
function actions(dir) {
|
||||
return Object.fromEntries(
|
||||
readdirSync(dir, { withFileTypes: true })
|
||||
.filter(entity => entity.isFile())
|
||||
.map(entity => {
|
||||
const actionName = basename(entity.name, extname(entity.name));
|
||||
const actionFile = resolve(dir, entity.name);
|
||||
return [actionName, actionFile];
|
||||
})
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get all external modules that should not be bundled.
|
||||
*
|
||||
* Note, currently `@actions/cache` can't be bundled by SWC due to modules issues in `@azure/*`:
|
||||
* > internal error: entered unreachable code: module item found but is_es6 is false
|
||||
*
|
||||
* @see https://github.com/expo/expo-github-action/pull/62
|
||||
*/
|
||||
function externals() {
|
||||
return ['@azure/storage-blob', '@azure/ms-rest-js'];
|
||||
}
|
||||
@@ -0,0 +1,61 @@
|
||||
import { addPath, getBooleanInput, getInput, group, info } from '@actions/core';
|
||||
|
||||
import { install } from '../install';
|
||||
import { resolveVersion } from '../packager';
|
||||
import * as tools from '../tools';
|
||||
|
||||
// Auto-execute in GitHub actions
|
||||
tools.performAction(setupAction);
|
||||
|
||||
export async function setupAction(): Promise<void> {
|
||||
const expoVersion = await installCli('expo-cli');
|
||||
const easVersion = await installCli('eas-cli');
|
||||
|
||||
await group('Checking current authenticated account', () =>
|
||||
tools.maybeAuthenticate({
|
||||
cli: expoVersion ? 'expo-cli' : easVersion ? 'eas-cli' : undefined,
|
||||
token: getInput('token') || undefined,
|
||||
username: getInput('username') || undefined,
|
||||
password: getInput('password') || undefined,
|
||||
})
|
||||
);
|
||||
|
||||
if (!getInput('patch-watchers') || getBooleanInput('patch-watchers') !== false) {
|
||||
await group('Patching system watchers for the `ENOSPC` error', () => tools.maybePatchWatchers());
|
||||
}
|
||||
}
|
||||
|
||||
async function installCli(name: tools.PackageName): Promise<string | void> {
|
||||
const shortName = tools.getBinaryName(name);
|
||||
const inputVersion = getInput(`${shortName}-version`);
|
||||
const packager = getInput('packager') || 'yarn';
|
||||
|
||||
if (!inputVersion) {
|
||||
return info(`Skipping installation of ${name}, \`${shortName}-version\` not provided.`);
|
||||
}
|
||||
|
||||
const version = await resolveVersion(name, inputVersion);
|
||||
const cache = getBooleanInput(`${shortName}-cache`);
|
||||
|
||||
try {
|
||||
const path = await group(
|
||||
cache
|
||||
? `Installing ${name} (${version}) from cache or with ${packager}`
|
||||
: `Installing ${name} (${version}) with ${packager}`,
|
||||
() =>
|
||||
install({
|
||||
packager,
|
||||
version,
|
||||
cache,
|
||||
package: name,
|
||||
cacheKey: getInput(`${shortName}-cache-key`) || undefined,
|
||||
})
|
||||
);
|
||||
|
||||
addPath(path);
|
||||
} catch (error) {
|
||||
tools.handleError(name, error);
|
||||
}
|
||||
|
||||
return version;
|
||||
}
|
||||
@@ -0,0 +1,94 @@
|
||||
import { ReserveCacheError, restoreCache, saveCache } from '@actions/cache';
|
||||
import * as core from '@actions/core';
|
||||
import * as toolCache from '@actions/tool-cache';
|
||||
import path from 'path';
|
||||
import os from 'os';
|
||||
|
||||
import type { InstallConfig } from './install';
|
||||
|
||||
export type CacheConfig = Omit<InstallConfig, 'cache'>;
|
||||
|
||||
/**
|
||||
* Get the path to the `expo-cli` from cache, if any.
|
||||
* Note, this cache is **NOT** shared between jobs.
|
||||
*
|
||||
* @see https://github.com/actions/toolkit/issues/47
|
||||
*/
|
||||
export async function fromLocalCache(config: CacheConfig): Promise<string | undefined> {
|
||||
return toolCache.find(config.package, config.version);
|
||||
}
|
||||
|
||||
/**
|
||||
* Store the root of `expo-cli` in the cache, for future reuse.
|
||||
* Note, this cache is **NOT** shared between jobs.
|
||||
*
|
||||
* @see https://github.com/actions/toolkit/issues/47
|
||||
*/
|
||||
export async function toLocalCache(root: string, config: CacheConfig): Promise<string> {
|
||||
return toolCache.cacheDir(root, config.package, config.version);
|
||||
}
|
||||
|
||||
/**
|
||||
* Download the remotely stored `expo-cli` from cache, if any.
|
||||
* Note, this cache is shared between jobs.
|
||||
*/
|
||||
export async function fromRemoteCache(config: CacheConfig): Promise<string | undefined> {
|
||||
// see: https://github.com/actions/toolkit/blob/8a4134761f09d0d97fb15f297705fd8644fef920/packages/tool-cache/src/tool-cache.ts#L401
|
||||
const target = path.join(process.env['RUNNER_TOOL_CACHE'] || '', config.package, config.version, os.arch());
|
||||
const cacheKey = config.cacheKey || getRemoteKey(config);
|
||||
|
||||
try {
|
||||
// When running with nektos/act, or other custom environments, the cache might not be set up.
|
||||
const hit = await restoreCache([target], cacheKey);
|
||||
if (hit) {
|
||||
return target;
|
||||
}
|
||||
} catch (error) {
|
||||
if (!handleRemoteCacheError(error)) {
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Store the root of `expo-cli` in the remote cache, for future reuse.
|
||||
* Note, this cache is shared between jobs.
|
||||
*/
|
||||
export async function toRemoteCache(source: string, config: CacheConfig): Promise<void> {
|
||||
const cacheKey = config.cacheKey || getRemoteKey(config);
|
||||
|
||||
try {
|
||||
await saveCache([source], cacheKey);
|
||||
} catch (error) {
|
||||
if (!handleRemoteCacheError(error)) {
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the cache key to use when (re)storing the Expo CLI from remote cache.
|
||||
*/
|
||||
function getRemoteKey(config: Omit<CacheConfig, 'cacheKey'>): string {
|
||||
return `${config.package}-${process.platform}-${os.arch()}-${config.packager}-${config.version}`;
|
||||
}
|
||||
|
||||
/**
|
||||
* Handle any incoming errors from cache methods.
|
||||
* This can include actual errors like `ReserveCacheErrors` or unavailability errors.
|
||||
* When the error is handled, it MUST provide feedback for the developer.
|
||||
*
|
||||
* @returns If the error was handled properly.
|
||||
*/
|
||||
function handleRemoteCacheError(error: Error): boolean {
|
||||
const isReserveCacheError = error instanceof ReserveCacheError;
|
||||
const isCacheUnavailable = error.message.toLowerCase().includes('cache service url not found');
|
||||
|
||||
if (isReserveCacheError || isCacheUnavailable) {
|
||||
core.warning('Skipping remote cache storage, encountered error:');
|
||||
core.warning(error.message);
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
@@ -0,0 +1,60 @@
|
||||
import * as core from '@actions/core';
|
||||
import * as cli from '@actions/exec';
|
||||
import * as io from '@actions/io';
|
||||
import * as path from 'path';
|
||||
|
||||
import { fromLocalCache, fromRemoteCache, toLocalCache, toRemoteCache } from './cache';
|
||||
import { PackageName } from './tools';
|
||||
|
||||
export type InstallConfig = {
|
||||
/** The exact version to install */
|
||||
version: string;
|
||||
/** The name of the package to install */
|
||||
package: PackageName;
|
||||
/** The packager to install with, likely to be `yarn` or `npm` */
|
||||
packager: string;
|
||||
/** If remote caching is enabled or not */
|
||||
cache?: boolean;
|
||||
/** The custom remote cache key */
|
||||
cacheKey?: string;
|
||||
};
|
||||
|
||||
/**
|
||||
* Install `expo-cli`, by version, using the packager.
|
||||
* Here you can provide any semver range or dist tag used in the registry.
|
||||
* It returns the path where Expo is installed.
|
||||
*/
|
||||
export async function install(config: InstallConfig): Promise<string> {
|
||||
let root: string | undefined = await fromLocalCache(config);
|
||||
|
||||
if (!root && config.cache) {
|
||||
root = await fromRemoteCache(config);
|
||||
} else {
|
||||
core.info('Skipping remote cache, not enabled...');
|
||||
}
|
||||
|
||||
if (!root) {
|
||||
root = await fromPackager(config);
|
||||
root = await toLocalCache(root, config);
|
||||
|
||||
if (config.cache) {
|
||||
await toRemoteCache(root, config);
|
||||
}
|
||||
}
|
||||
|
||||
return path.join(root, 'node_modules', '.bin');
|
||||
}
|
||||
|
||||
/**
|
||||
* Install `expo-cli`, by version, using npm or yarn.
|
||||
* It creates a temporary directory to store all required files.
|
||||
*/
|
||||
export async function fromPackager(config: InstallConfig): Promise<string> {
|
||||
const root = process.env['RUNNER_TEMP'] || '';
|
||||
const tool = await io.which(config.packager);
|
||||
|
||||
await io.mkdirP(root);
|
||||
await cli.exec(tool, ['add', `${config.package}@${config.version}`], { cwd: root });
|
||||
|
||||
return root;
|
||||
}
|
||||
@@ -0,0 +1,30 @@
|
||||
import { exec } from '@actions/exec';
|
||||
|
||||
/**
|
||||
* Resolve a package with version range to an exact version.
|
||||
* This is useful to invalidate the cache _and_ using dist-tags or version ranges.
|
||||
* It executes `npm info` and parses the latest manifest.
|
||||
*/
|
||||
export async function resolveVersion(name: string, range: string): Promise<string> {
|
||||
let stdout = '';
|
||||
|
||||
try {
|
||||
await exec('npm', ['info', `${name}@${range}`, 'version', '--json'], {
|
||||
silent: true,
|
||||
listeners: {
|
||||
stdout(data) {
|
||||
stdout += data.toString();
|
||||
},
|
||||
},
|
||||
});
|
||||
} catch (error) {
|
||||
throw new Error(`Could not resolve version "${range}" of "${name}", reason:\n${error.message || error}`);
|
||||
}
|
||||
|
||||
// thanks npm, for returning a "x.x.x" json value...
|
||||
if (stdout.startsWith('"')) {
|
||||
stdout = `[${stdout}]`;
|
||||
}
|
||||
|
||||
return JSON.parse(stdout).at(-1);
|
||||
}
|
||||
+132
@@ -0,0 +1,132 @@
|
||||
import * as core from '@actions/core';
|
||||
import * as cli from '@actions/exec';
|
||||
import semver from 'semver';
|
||||
|
||||
import { resolveVersion } from './packager';
|
||||
|
||||
export type PackageName = 'expo-cli' | 'eas-cli';
|
||||
|
||||
export type AuthenticateOptions = {
|
||||
cli?: PackageName;
|
||||
token?: string;
|
||||
username?: string;
|
||||
password?: string;
|
||||
};
|
||||
|
||||
/**
|
||||
* Convert `expo-cli` or `eas-cli` to just their binary name.
|
||||
* For windows we have to use `<bin>.cmd`, toolkit will handle the Windows binary with that.
|
||||
*/
|
||||
export function getBinaryName(name: PackageName, forWindows = false): string {
|
||||
const bin = name.toLowerCase().replace('-cli', '');
|
||||
return forWindows ? `${bin}.cmd` : bin;
|
||||
}
|
||||
|
||||
/**
|
||||
* Authenticate with Expo using either the token or username/password method.
|
||||
* If both of them are set, token has priority.
|
||||
*/
|
||||
export async function maybeAuthenticate(options: AuthenticateOptions = {}): Promise<void> {
|
||||
if (options.token) {
|
||||
if (options.cli) {
|
||||
const bin = getBinaryName(options.cli, process.platform === 'win32');
|
||||
await cli.exec(bin, ['whoami'], {
|
||||
env: { ...process.env, EXPO_TOKEN: options.token },
|
||||
});
|
||||
} else {
|
||||
core.info("Skipping token validation: no CLI installed, can't run `whoami`.");
|
||||
}
|
||||
|
||||
return core.exportVariable('EXPO_TOKEN', options.token);
|
||||
}
|
||||
|
||||
if (options.username || options.password) {
|
||||
if (options.cli !== 'expo-cli') {
|
||||
return core.warning(
|
||||
'Skipping authentication: only Expo CLI supports programmatic credentials, use `token` instead.'
|
||||
);
|
||||
}
|
||||
|
||||
if (!options.username || !options.password) {
|
||||
return core.info('Skipping authentication: `username` and/or `password` not set...');
|
||||
}
|
||||
|
||||
const bin = getBinaryName(options.cli, process.platform === 'win32');
|
||||
await cli.exec(bin, ['login', `--username=${options.username}`], {
|
||||
env: { ...process.env, EXPO_CLI_PASSWORD: options.password },
|
||||
});
|
||||
}
|
||||
|
||||
core.info('Skipping authentication: `token`, `username`, and/or `password` not set...');
|
||||
}
|
||||
|
||||
/**
|
||||
* Try to patch the default watcher/inotify limit.
|
||||
* This is a limitation from GitHub Actions and might be an issue in some Expo projects.
|
||||
* It sets the system's `fs.inotify` limits to a more sensible setting.
|
||||
*
|
||||
* @see https://github.com/expo/expo-github-action/issues/20
|
||||
*/
|
||||
export async function maybePatchWatchers(): Promise<void> {
|
||||
if (process.platform !== 'linux') {
|
||||
return core.info('Skipping patch for watchers, not running on Linux...');
|
||||
}
|
||||
|
||||
core.info('Patching system watchers for the `ENOSPC` error...');
|
||||
|
||||
try {
|
||||
// see https://github.com/expo/expo-cli/issues/277#issuecomment-452685177
|
||||
await cli.exec('sudo sysctl fs.inotify.max_user_instances=524288');
|
||||
await cli.exec('sudo sysctl fs.inotify.max_user_watches=524288');
|
||||
await cli.exec('sudo sysctl fs.inotify.max_queued_events=524288');
|
||||
await cli.exec('sudo sysctl -p');
|
||||
} catch {
|
||||
core.warning("Looks like we can't patch watchers/inotify limits, you might encouter the `ENOSPC` error.");
|
||||
core.warning('For more info, https://github.com/expo/expo-github-action/issues/20');
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if there is a new major version available.
|
||||
* If there is, create a warning for people to upgrade their workflow.
|
||||
* Because this introduces additional requests, it should only be executed when necessary.
|
||||
*/
|
||||
export async function maybeWarnForUpdate(name: PackageName): Promise<void> {
|
||||
const binaryName = getBinaryName(name);
|
||||
const latest = await resolveVersion(name, 'latest');
|
||||
const current = await resolveVersion(name, core.getInput(`${getBinaryName(name)}-version`) || 'latest');
|
||||
|
||||
if (semver.diff(latest, current) === 'major') {
|
||||
core.warning(`There is a new major version available of the Expo CLI (${latest})`);
|
||||
core.warning(
|
||||
`If you run into issues, try upgrading your workflow to "${binaryName}-version: ${semver.major(latest)}.x"`
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Handle errors when this action fails, providing useful next-steps for developers.
|
||||
* This mostly checks if the installed version is the latest version.
|
||||
*/
|
||||
export async function handleError(name: PackageName, error: Error) {
|
||||
try {
|
||||
await maybeWarnForUpdate(name);
|
||||
} catch {
|
||||
// If this fails, ignore it
|
||||
}
|
||||
|
||||
core.setFailed(error);
|
||||
}
|
||||
|
||||
/**
|
||||
* Auto-execute the action if it's not running in a test environment.
|
||||
* This is useful to test the action, without running it in tests.
|
||||
* The method can also be mocked.
|
||||
*/
|
||||
export function performAction(action: () => Promise<void>) {
|
||||
if (process.env.JEST_WORKER_ID) {
|
||||
return Promise.resolve(null);
|
||||
}
|
||||
|
||||
return action();
|
||||
}
|
||||
@@ -0,0 +1,132 @@
|
||||
import { getToolsMock, mockInput } from '../utils';
|
||||
|
||||
jest.mock('../../src/tools', () => getToolsMock());
|
||||
jest.mock('../../src/packager', () => ({
|
||||
async resolveVersion(_: string, version: string) {
|
||||
return version;
|
||||
},
|
||||
}));
|
||||
|
||||
import * as core from '@actions/core';
|
||||
|
||||
import * as install from '../../src/install';
|
||||
import * as tools from '../../src/tools';
|
||||
import { setupAction } from '../../src/actions/setup';
|
||||
|
||||
describe(setupAction, () => {
|
||||
describe('patch watchers', () => {
|
||||
it('patches the system when set to true', async () => {
|
||||
mockInput({ 'patch-watchers': 'true' });
|
||||
await setupAction();
|
||||
expect(tools.maybePatchWatchers).toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('patches the system when not set', async () => {
|
||||
mockInput({ 'patch-watchers': '' });
|
||||
await setupAction();
|
||||
expect(tools.maybePatchWatchers).toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('skips the system patch when set to false', async () => {
|
||||
mockInput({ 'patch-watchers': 'false' });
|
||||
await setupAction();
|
||||
expect(tools.maybePatchWatchers).not.toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
|
||||
describe('authentication', () => {
|
||||
it('authenticates with provided credentials', async () => {
|
||||
mockInput({ username: 'bycedric', password: 'mypassword' });
|
||||
await setupAction();
|
||||
expect(tools.maybeAuthenticate).toBeCalledWith({ username: 'bycedric', password: 'mypassword' });
|
||||
});
|
||||
|
||||
it('authenticates with provided token', async () => {
|
||||
mockInput({ token: 'ABC123' });
|
||||
await setupAction();
|
||||
expect(tools.maybeAuthenticate).toBeCalledWith({ token: 'ABC123' });
|
||||
});
|
||||
});
|
||||
|
||||
['expo', 'eas'].forEach(cliName => {
|
||||
const packageName = `${cliName}-cli`;
|
||||
let installMock: jest.SpyInstance;
|
||||
|
||||
beforeEach(() => {
|
||||
installMock = jest.spyOn(install, 'install').mockImplementation();
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
installMock.mockRestore();
|
||||
});
|
||||
|
||||
describe(packageName, () => {
|
||||
it(`skips installation without \`${cliName}-version\``, async () => {
|
||||
mockInput();
|
||||
await setupAction();
|
||||
expect(installMock).not.toBeCalledWith({ package: packageName });
|
||||
});
|
||||
|
||||
it('installs with yarn by default', async () => {
|
||||
mockInput({ [`${cliName}-version`]: 'latest' });
|
||||
await setupAction();
|
||||
expect(installMock).toBeCalledWith({
|
||||
package: packageName,
|
||||
version: 'latest',
|
||||
packager: 'yarn',
|
||||
cache: false,
|
||||
});
|
||||
});
|
||||
|
||||
it('installs provided version with npm', async () => {
|
||||
mockInput({ [`${cliName}-version`]: '3.0.10', packager: 'npm' });
|
||||
await setupAction();
|
||||
expect(installMock).toBeCalledWith({
|
||||
package: packageName,
|
||||
version: '3.0.10',
|
||||
packager: 'npm',
|
||||
cache: false,
|
||||
});
|
||||
});
|
||||
|
||||
it('installs with yarn and cache enabled', async () => {
|
||||
mockInput({
|
||||
packager: 'yarn',
|
||||
[`${cliName}-version`]: '4.2.0',
|
||||
[`${cliName}-cache`]: 'true',
|
||||
});
|
||||
await setupAction();
|
||||
expect(installMock).toBeCalledWith({
|
||||
package: packageName,
|
||||
version: '4.2.0',
|
||||
packager: 'yarn',
|
||||
cache: true,
|
||||
});
|
||||
});
|
||||
|
||||
it('installs with yarn and custom cache key', async () => {
|
||||
mockInput({
|
||||
packager: 'yarn',
|
||||
[`${cliName}-version`]: '4.2.0',
|
||||
[`${cliName}-cache`]: 'true',
|
||||
[`${cliName}-cache-key`]: 'custom-key',
|
||||
});
|
||||
await setupAction();
|
||||
expect(installMock).toBeCalledWith({
|
||||
package: packageName,
|
||||
version: '4.2.0',
|
||||
packager: 'yarn',
|
||||
cache: true,
|
||||
cacheKey: 'custom-key',
|
||||
});
|
||||
});
|
||||
|
||||
it('installs path to global path', async () => {
|
||||
installMock.mockResolvedValue(`/${cliName}/install/path`);
|
||||
const addPathSpy = jest.spyOn(core, 'addPath').mockImplementation();
|
||||
await setupAction();
|
||||
expect(addPathSpy).toBeCalledWith(`/${cliName}/install/path`);
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,153 @@
|
||||
import os from 'os';
|
||||
import { join } from 'path';
|
||||
import * as remoteCache from '@actions/cache';
|
||||
import * as core from '@actions/core';
|
||||
import * as toolCache from '@actions/tool-cache';
|
||||
|
||||
import * as cache from '../src/cache';
|
||||
import * as utils from './utils';
|
||||
|
||||
describe(cache.fromLocalCache, () => {
|
||||
it('fetches the version specific cache', async () => {
|
||||
const path = join('path', 'to', 'local', 'cache');
|
||||
// todo: check why jest wants `never` instead of `string`
|
||||
const find = jest.spyOn(toolCache, 'find').mockResolvedValue(path as never);
|
||||
const result = await cache.fromLocalCache({ package: 'eas-cli', version: '4.2.0', packager: 'npm' });
|
||||
expect(result).toBe(path);
|
||||
expect(find).toBeCalledWith('eas-cli', '4.2.0');
|
||||
});
|
||||
});
|
||||
|
||||
describe(cache.toLocalCache, () => {
|
||||
it('stores the version specific cache', async () => {
|
||||
const path = join('path', 'to', 'local', 'cache');
|
||||
const root = join('path', 'from', 'source');
|
||||
const cacheDir = jest.spyOn(toolCache, 'cacheDir').mockResolvedValue(path);
|
||||
const result = await cache.toLocalCache(root, { package: 'expo-cli', version: '4.2.0', packager: 'yarn' });
|
||||
expect(result).toBe(path);
|
||||
expect(cacheDir).toBeCalledWith(root, 'expo-cli', '4.2.0');
|
||||
});
|
||||
});
|
||||
|
||||
describe(cache.fromRemoteCache, () => {
|
||||
let spy: { [key: string]: jest.SpyInstance } = {};
|
||||
|
||||
beforeEach(() => {
|
||||
spy = {
|
||||
restore: jest.spyOn(remoteCache, 'restoreCache').mockImplementation(),
|
||||
warning: jest.spyOn(core, 'warning').mockImplementation(),
|
||||
};
|
||||
});
|
||||
|
||||
beforeAll(() => {
|
||||
utils.setEnv('RUNNER_TOOL_CACHE', join('cache', 'path'));
|
||||
});
|
||||
|
||||
afterAll(() => {
|
||||
utils.restoreEnv();
|
||||
spy.restore.mockRestore();
|
||||
spy.warning.mockRestore();
|
||||
});
|
||||
|
||||
it('restores remote cache with default key', async () => {
|
||||
expect(await cache.fromRemoteCache({ package: 'expo-cli', version: '3.20.1', packager: 'yarn' })).toBeUndefined();
|
||||
expect(remoteCache.restoreCache).toBeCalledWith(
|
||||
[join('cache', 'path', 'expo-cli', '3.20.1', os.arch())],
|
||||
`expo-cli-${process.platform}-${os.arch()}-yarn-3.20.1`
|
||||
);
|
||||
});
|
||||
|
||||
it('restores remote cache with custom key', async () => {
|
||||
expect(
|
||||
await cache.fromRemoteCache({
|
||||
package: 'eas-cli',
|
||||
version: '4.2.0',
|
||||
packager: 'yarn',
|
||||
cacheKey: 'custom-cache-key',
|
||||
})
|
||||
).toBeUndefined();
|
||||
expect(remoteCache.restoreCache).toBeCalledWith(
|
||||
[join('cache', 'path', 'eas-cli', '4.2.0', os.arch())],
|
||||
'custom-cache-key'
|
||||
);
|
||||
});
|
||||
|
||||
it('returns path when remote cache exists', async () => {
|
||||
spy.restore.mockResolvedValueOnce(true);
|
||||
expect(await cache.fromRemoteCache({ package: 'expo-cli', version: '3.20.1', packager: 'npm' })).toBe(
|
||||
join('cache', 'path', 'expo-cli', '3.20.1', os.arch())
|
||||
);
|
||||
});
|
||||
|
||||
it('fails when remote cache throws', async () => {
|
||||
const error = new Error('Remote cache restore failed');
|
||||
spy.restore.mockRejectedValueOnce(error);
|
||||
await expect(cache.fromRemoteCache({ package: 'eas-cli', version: '3.20.1', packager: 'yarn' })).rejects.toBe(
|
||||
error
|
||||
);
|
||||
});
|
||||
|
||||
it('skips remote cache when unavailable', async () => {
|
||||
// see: https://github.com/actions/toolkit/blob/9167ce1f3a32ad495fc1dbcb574c03c0e013ae53/packages/cache/src/internal/cacheHttpClient.ts#L41
|
||||
const error = new Error('Cache Service Url not found, unable to restore cache.');
|
||||
spy.restore.mockRejectedValueOnce(error);
|
||||
expect(await cache.fromRemoteCache({ package: 'expo-cli', version: '3.20.1', packager: 'yarn' })).toBeUndefined();
|
||||
expect(spy.warning).toHaveBeenCalledWith(expect.stringContaining('Skipping remote cache'));
|
||||
});
|
||||
});
|
||||
|
||||
describe(cache.toRemoteCache, () => {
|
||||
let spy: { [key: string]: jest.SpyInstance } = {};
|
||||
|
||||
beforeEach(() => {
|
||||
spy = {
|
||||
save: jest.spyOn(remoteCache, 'saveCache').mockImplementation(),
|
||||
warning: jest.spyOn(core, 'warning').mockImplementation(),
|
||||
};
|
||||
});
|
||||
|
||||
afterAll(() => {
|
||||
spy.save.mockRestore();
|
||||
spy.warning.mockRestore();
|
||||
});
|
||||
|
||||
it('saves remote cache with default key', async () => {
|
||||
expect(
|
||||
await cache.toRemoteCache(join('local', 'path'), { package: 'eas-cli', version: '3.20.1', packager: 'npm' })
|
||||
).toBeUndefined();
|
||||
expect(remoteCache.saveCache).toBeCalledWith(
|
||||
[join('local', 'path')],
|
||||
`eas-cli-${process.platform}-${os.arch()}-npm-3.20.1`
|
||||
);
|
||||
});
|
||||
|
||||
it('saves remote cache with custom key', async () => {
|
||||
expect(
|
||||
await cache.toRemoteCache(join('local', 'path'), {
|
||||
package: 'eas-cli',
|
||||
version: '3.20.1',
|
||||
packager: 'yarn',
|
||||
cacheKey: 'custom-cache-key',
|
||||
})
|
||||
).toBeUndefined();
|
||||
expect(remoteCache.saveCache).toBeCalledWith([join('local', 'path')], 'custom-cache-key');
|
||||
});
|
||||
|
||||
it('fails when remote cache throws', async () => {
|
||||
const error = new Error('Remote cache save failed');
|
||||
spy.save.mockRejectedValueOnce(error);
|
||||
await expect(
|
||||
cache.toRemoteCache(join('local', 'path'), { package: 'expo-cli', version: '3.20.1', packager: 'yarn' })
|
||||
).rejects.toBe(error);
|
||||
});
|
||||
|
||||
it('skips remote cache when unavailable', async () => {
|
||||
// see: https://github.com/actions/toolkit/blob/9167ce1f3a32ad495fc1dbcb574c03c0e013ae53/packages/cache/src/internal/cacheHttpClient.ts#L41
|
||||
const error = new Error('Cache Service Url not found, unable to restore cache.');
|
||||
spy.save.mockRejectedValueOnce(error);
|
||||
await expect(
|
||||
cache.toRemoteCache(join('local', 'path'), { package: 'expo-cli', version: '3.20.1', packager: 'yarn' })
|
||||
).resolves.toBeUndefined();
|
||||
expect(spy.warning).toHaveBeenCalledWith(expect.stringContaining('Skipping remote cache'));
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,94 @@
|
||||
const cli = { exec: jest.fn() };
|
||||
const io = { mkdirP: jest.fn(), which: jest.fn() };
|
||||
const cache = {
|
||||
fromLocalCache: jest.fn(),
|
||||
fromRemoteCache: jest.fn(),
|
||||
toLocalCache: jest.fn(),
|
||||
toRemoteCache: jest.fn(),
|
||||
};
|
||||
|
||||
jest.mock('@actions/exec', () => cli);
|
||||
jest.mock('@actions/io', () => io);
|
||||
jest.mock('../src/cache', () => cache);
|
||||
|
||||
import { join } from 'path';
|
||||
|
||||
import * as install from '../src/install';
|
||||
import * as utils from './utils';
|
||||
|
||||
describe('install', () => {
|
||||
it('installs path from local cache', async () => {
|
||||
cache.fromLocalCache.mockResolvedValue(join('cache', 'path'));
|
||||
const expoPath = await install.install({ package: 'expo-cli', version: '3.0.10', packager: 'npm' });
|
||||
expect(expoPath).toBe(join('cache', 'path', 'node_modules', '.bin'));
|
||||
});
|
||||
|
||||
it('installs path from packager and cache it locally', async () => {
|
||||
utils.setEnv('RUNNER_TEMP', join('temp', 'path'));
|
||||
cache.fromLocalCache.mockResolvedValue(undefined);
|
||||
cache.toLocalCache.mockResolvedValue(join('cache', 'path'));
|
||||
const expoPath = await install.install({ package: 'expo-cli', version: '3.0.10', packager: 'npm' });
|
||||
expect(expoPath).toBe(join('cache', 'path', 'node_modules', '.bin'));
|
||||
expect(cache.toLocalCache).toBeCalledWith(join('temp', 'path'), {
|
||||
package: 'expo-cli',
|
||||
version: '3.0.10',
|
||||
packager: 'npm',
|
||||
});
|
||||
utils.restoreEnv();
|
||||
});
|
||||
|
||||
it('installs path from remote cache', async () => {
|
||||
cache.fromLocalCache.mockResolvedValue(undefined);
|
||||
cache.fromRemoteCache.mockResolvedValue(join('cache', 'path'));
|
||||
const expoPath = await install.install({ package: 'eas-cli', version: '4.2.0', packager: 'yarn', cache: true });
|
||||
expect(expoPath).toBe(join('cache', 'path', 'node_modules', '.bin'));
|
||||
expect(cache.fromRemoteCache).toBeCalledWith({
|
||||
package: 'eas-cli',
|
||||
version: '4.2.0',
|
||||
packager: 'yarn',
|
||||
cache: true,
|
||||
});
|
||||
});
|
||||
|
||||
it('installs path from packager and cache it remotely', async () => {
|
||||
utils.setEnv('RUNNER_TEMP', join('temp', 'path'));
|
||||
cache.fromLocalCache.mockResolvedValue(undefined);
|
||||
cache.fromRemoteCache.mockResolvedValue(undefined);
|
||||
cache.toLocalCache.mockResolvedValue(join('cache', 'path'));
|
||||
const expoPath = await install.install({ package: 'expo-cli', version: '3.20.1', packager: 'npm', cache: true });
|
||||
expect(expoPath).toBe(join('cache', 'path', 'node_modules', '.bin'));
|
||||
expect(cache.toRemoteCache).toBeCalledWith(join('cache', 'path'), {
|
||||
package: 'expo-cli',
|
||||
version: '3.20.1',
|
||||
packager: 'npm',
|
||||
cache: true,
|
||||
});
|
||||
utils.restoreEnv();
|
||||
});
|
||||
});
|
||||
|
||||
describe('fromPackager', () => {
|
||||
it('resolves tool path', async () => {
|
||||
await install.fromPackager({ package: 'expo-cli', version: '3.0.10', packager: 'npm' });
|
||||
expect(io.which).toBeCalledWith('npm');
|
||||
});
|
||||
|
||||
it('creates temporary folder', async () => {
|
||||
utils.setEnv('RUNNER_TEMP', join('temp', 'path'));
|
||||
await install.fromPackager({ package: 'eas-cli', version: 'latest', packager: 'yarn' });
|
||||
expect(io.mkdirP).toBeCalledWith(join('temp', 'path'));
|
||||
utils.restoreEnv();
|
||||
});
|
||||
|
||||
it('installs expo with tool', async () => {
|
||||
utils.setEnv('RUNNER_TEMP', join('temp', 'path'));
|
||||
io.which.mockResolvedValue('npm');
|
||||
const expoPath = await install.fromPackager({ package: 'eas-cli', version: 'beta', packager: 'npm' });
|
||||
expect(expoPath).toBe(join('temp', 'path'));
|
||||
expect(cli.exec).toBeCalled();
|
||||
expect(cli.exec.mock.calls[0][0]).toBe('npm');
|
||||
expect(cli.exec.mock.calls[0][1]).toStrictEqual(['add', 'eas-cli@beta']);
|
||||
expect(cli.exec.mock.calls[0][2]).toMatchObject({ cwd: join('temp', 'path') });
|
||||
utils.restoreEnv();
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,27 @@
|
||||
import { valid as validVersion } from 'semver';
|
||||
import { resolveVersion } from '../src/packager';
|
||||
|
||||
describe(resolveVersion, () => {
|
||||
it('resolves expo-cli@^2.0.0 to 2.21.2', async () => {
|
||||
await expect(resolveVersion('expo-cli', '^2.0.0')).resolves.toBe('2.21.2');
|
||||
});
|
||||
|
||||
it('resolves expo-cli@~3.15.0 to 3.15.5', async () => {
|
||||
await expect(resolveVersion('expo-cli', '~3.15.0')).resolves.toBe('3.15.5');
|
||||
});
|
||||
|
||||
it('resolves eas-cli@~0.33.0 to 0.33.1', async () => {
|
||||
await expect(resolveVersion('eas-cli', '~0.33.0')).resolves.toBe('0.33.1');
|
||||
});
|
||||
|
||||
it('resolves expo-cli@latest to a valid version', async () => {
|
||||
const version = await resolveVersion('expo-cli', 'latest');
|
||||
expect(validVersion(version)).not.toBeNull();
|
||||
});
|
||||
|
||||
it('rejects donotpublishthispackageoryouwillbefired with proper error', async () => {
|
||||
await expect(resolveVersion('donotpublishthispackageoryouwillbefired', 'latest')).rejects.toThrow(
|
||||
'Could not resolve version "latest" of "donotpublishthispackageoryouwillbefired"'
|
||||
);
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,328 @@
|
||||
import * as core from '@actions/core';
|
||||
import * as cli from '@actions/exec';
|
||||
|
||||
import * as tools from '../src/tools';
|
||||
import * as packager from '../src/packager';
|
||||
import * as utils from './utils';
|
||||
|
||||
describe(tools.getBinaryName, () => {
|
||||
it('returns expo for `expo-cli`', () => {
|
||||
expect(tools.getBinaryName('expo-cli')).toBe('expo');
|
||||
});
|
||||
|
||||
it('returns eas for `eas-cli`', () => {
|
||||
expect(tools.getBinaryName('eas-cli')).toBe('eas');
|
||||
});
|
||||
|
||||
it('returns eas.cmd for `eas-cli` for windows', () => {
|
||||
expect(tools.getBinaryName('eas-cli', true)).toBe('eas.cmd');
|
||||
});
|
||||
});
|
||||
|
||||
describe(tools.maybeAuthenticate, () => {
|
||||
const token = 'ABC123';
|
||||
const username = 'bycedric';
|
||||
const password = 'mypassword';
|
||||
|
||||
describe('with token', () => {
|
||||
let spy: { [key: string]: jest.SpyInstance } = {};
|
||||
|
||||
beforeEach(() => {
|
||||
spy = {
|
||||
exportVariable: jest.spyOn(core, 'exportVariable').mockImplementation(),
|
||||
exec: jest.spyOn(cli, 'exec').mockImplementation(),
|
||||
info: jest.spyOn(core, 'info').mockImplementation(),
|
||||
};
|
||||
});
|
||||
|
||||
afterAll(() => {
|
||||
spy.exportVariable.mockRestore();
|
||||
spy.exec.mockRestore();
|
||||
spy.info.mockRestore();
|
||||
});
|
||||
|
||||
it('skips authentication without token', async () => {
|
||||
await tools.maybeAuthenticate();
|
||||
expect(spy.exec).not.toBeCalled();
|
||||
expect(spy.info).toBeCalledWith(expect.stringContaining('Skipping authentication'));
|
||||
});
|
||||
|
||||
it('executes whoami command with token through environment', async () => {
|
||||
utils.setEnv('TEST_INCLUDED', 'hellyeah');
|
||||
await tools.maybeAuthenticate({ token, cli: 'expo-cli' });
|
||||
expect(spy.exec).toBeCalled();
|
||||
expect(spy.exec.mock.calls[0][1]).toStrictEqual(['whoami']);
|
||||
expect(spy.exec.mock.calls[0][2]).toMatchObject({
|
||||
env: {
|
||||
TEST_INCLUDED: 'hellyeah',
|
||||
EXPO_TOKEN: token,
|
||||
},
|
||||
});
|
||||
utils.restoreEnv();
|
||||
});
|
||||
|
||||
it('fails when token is incorrect', async () => {
|
||||
const error = new Error('Not logged in');
|
||||
spy.exec.mockRejectedValue(error);
|
||||
await expect(tools.maybeAuthenticate({ token, cli: 'expo-cli' })).rejects.toBe(error);
|
||||
});
|
||||
|
||||
it('skips validation without cli', async () => {
|
||||
await tools.maybeAuthenticate({ token });
|
||||
expect(spy.exec).not.toBeCalled();
|
||||
expect(spy.info).toBeCalledWith(expect.stringContaining('Skipping token validation'));
|
||||
});
|
||||
|
||||
it('executes whoami command with `expo` on macos', async () => {
|
||||
utils.setPlatform('darwin');
|
||||
await tools.maybeAuthenticate({ token, cli: 'expo-cli' });
|
||||
expect(spy.exec).toBeCalled();
|
||||
expect(spy.exec.mock.calls[0][0]).toBe('expo');
|
||||
utils.restorePlatform();
|
||||
});
|
||||
|
||||
it('executes whoami command with `eas` on ubuntu', async () => {
|
||||
utils.setPlatform('linux');
|
||||
await tools.maybeAuthenticate({ token, cli: 'eas-cli' });
|
||||
expect(spy.exec).toBeCalled();
|
||||
expect(spy.exec.mock.calls[0][0]).toBe('eas');
|
||||
utils.restorePlatform();
|
||||
});
|
||||
|
||||
it('executes whoami command with `expo.cmd` on windows', async () => {
|
||||
utils.setPlatform('win32');
|
||||
await tools.maybeAuthenticate({ token, cli: 'expo-cli' });
|
||||
expect(spy.exec).toBeCalled();
|
||||
expect(spy.exec.mock.calls[0][0]).toBe('expo.cmd');
|
||||
utils.restorePlatform();
|
||||
});
|
||||
});
|
||||
|
||||
describe('credentials', () => {
|
||||
let spy: { [key: string]: jest.SpyInstance } = {};
|
||||
|
||||
beforeEach(() => {
|
||||
spy = {
|
||||
exec: jest.spyOn(cli, 'exec').mockImplementation(),
|
||||
info: jest.spyOn(core, 'info').mockImplementation(),
|
||||
warning: jest.spyOn(core, 'warning').mockImplementation(),
|
||||
};
|
||||
});
|
||||
|
||||
afterAll(() => {
|
||||
spy.exec.mockRestore();
|
||||
spy.info.mockRestore();
|
||||
spy.warning.mockRestore();
|
||||
});
|
||||
|
||||
it('skips authentication without cli', async () => {
|
||||
await tools.maybeAuthenticate({});
|
||||
expect(spy.exec).not.toBeCalled();
|
||||
expect(spy.info).toBeCalledWith(expect.stringContaining('Skipping authentication'));
|
||||
});
|
||||
|
||||
it('skips authentication without credentials', async () => {
|
||||
await tools.maybeAuthenticate({ cli: 'expo-cli' });
|
||||
expect(spy.exec).not.toBeCalled();
|
||||
expect(spy.info).toBeCalledWith(expect.stringContaining('Skipping authentication'));
|
||||
});
|
||||
|
||||
it('skips authentication without password', async () => {
|
||||
await tools.maybeAuthenticate({ username, cli: 'expo-cli' });
|
||||
expect(spy.exec).not.toBeCalled();
|
||||
expect(spy.info).toBeCalledWith(expect.stringContaining('Skipping authentication'));
|
||||
});
|
||||
|
||||
it('skips authentication with credentials for eas-cli', async () => {
|
||||
await tools.maybeAuthenticate({ username, password, cli: 'eas-cli' });
|
||||
expect(spy.exec).not.toBeCalled();
|
||||
expect(spy.warning).toBeCalledWith(expect.stringContaining('Skipping authentication'));
|
||||
});
|
||||
|
||||
it('executes login command with password through environment', async () => {
|
||||
utils.setEnv('TEST_INCLUDED', 'hellyeah');
|
||||
await tools.maybeAuthenticate({ username, password, cli: 'expo-cli' });
|
||||
expect(spy.exec).toBeCalled();
|
||||
expect(spy.exec.mock.calls[0][1]).toStrictEqual(['login', `--username=${username}`]);
|
||||
expect(spy.exec.mock.calls[0][2]).toMatchObject({
|
||||
env: {
|
||||
TEST_INCLUDED: 'hellyeah',
|
||||
EXPO_CLI_PASSWORD: password,
|
||||
},
|
||||
});
|
||||
utils.restoreEnv();
|
||||
});
|
||||
|
||||
it('fails when credentials are incorrect', async () => {
|
||||
const error = new Error('Invalid username/password. Please try again.');
|
||||
spy.exec.mockRejectedValue(error);
|
||||
await expect(tools.maybeAuthenticate({ username, password, cli: 'expo-cli' })).rejects.toBe(error);
|
||||
});
|
||||
|
||||
it('executes login command with `expo` on macos', async () => {
|
||||
utils.setPlatform('darwin');
|
||||
await tools.maybeAuthenticate({ username, password, cli: 'expo-cli' });
|
||||
expect(spy.exec).toBeCalled();
|
||||
expect(spy.exec.mock.calls[0][0]).toBe('expo');
|
||||
utils.restorePlatform();
|
||||
});
|
||||
|
||||
it('executes login command with `expo` on ubuntu', async () => {
|
||||
utils.setPlatform('linux');
|
||||
await tools.maybeAuthenticate({ username, password, cli: 'expo-cli' });
|
||||
expect(spy.exec).toBeCalled();
|
||||
expect(spy.exec.mock.calls[0][0]).toBe('expo');
|
||||
utils.restorePlatform();
|
||||
});
|
||||
|
||||
it('executes login command with `expo.cmd` on windows', async () => {
|
||||
utils.setPlatform('win32');
|
||||
await tools.maybeAuthenticate({ username, password, cli: 'expo-cli' });
|
||||
expect(spy.exec).toBeCalled();
|
||||
expect(spy.exec.mock.calls[0][0]).toBe('expo.cmd');
|
||||
utils.restorePlatform();
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe(tools.maybePatchWatchers, () => {
|
||||
let spy: { [key: string]: jest.SpyInstance } = {};
|
||||
|
||||
beforeEach(() => {
|
||||
spy = {
|
||||
info: jest.spyOn(core, 'info').mockImplementation(),
|
||||
warning: jest.spyOn(core, 'warning').mockImplementation(),
|
||||
exec: jest.spyOn(cli, 'exec').mockImplementation(),
|
||||
};
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
utils.restorePlatform();
|
||||
});
|
||||
|
||||
afterAll(() => {
|
||||
spy.info.mockRestore();
|
||||
spy.warning.mockRestore();
|
||||
spy.exec.mockRestore();
|
||||
});
|
||||
|
||||
it('increses fs inotify settings with sysctl', async () => {
|
||||
utils.setPlatform('linux');
|
||||
await tools.maybePatchWatchers();
|
||||
expect(spy.exec).toBeCalledWith('sudo sysctl fs.inotify.max_user_instances=524288');
|
||||
expect(spy.exec).toBeCalledWith('sudo sysctl fs.inotify.max_user_watches=524288');
|
||||
expect(spy.exec).toBeCalledWith('sudo sysctl fs.inotify.max_queued_events=524288');
|
||||
expect(spy.exec).toBeCalledWith('sudo sysctl -p');
|
||||
});
|
||||
|
||||
it('warns for unsuccessful patches', async () => {
|
||||
const error = new Error('Something went wrong');
|
||||
spy.exec.mockRejectedValueOnce(error);
|
||||
utils.setPlatform('linux');
|
||||
await tools.maybePatchWatchers();
|
||||
expect(core.warning).toBeCalledWith(expect.stringContaining("can't patch watchers"));
|
||||
expect(core.warning).toBeCalledWith(
|
||||
expect.stringContaining('https://github.com/expo/expo-github-action/issues/20')
|
||||
);
|
||||
});
|
||||
|
||||
it('skips on windows platform', async () => {
|
||||
utils.setPlatform('win32');
|
||||
await tools.maybePatchWatchers();
|
||||
expect(spy.info).toBeCalledWith(expect.stringContaining('Skipping'));
|
||||
expect(spy.exec).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('skips on macos platform', async () => {
|
||||
utils.setPlatform('darwin');
|
||||
await tools.maybePatchWatchers();
|
||||
expect(spy.info).toBeCalledWith(expect.stringContaining('Skipping'));
|
||||
expect(spy.exec).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('runs on linux platform', async () => {
|
||||
utils.setPlatform('linux');
|
||||
await tools.maybePatchWatchers();
|
||||
expect(spy.info).toBeCalledWith(expect.stringContaining('Patching'));
|
||||
expect(spy.exec).toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
|
||||
describe(tools.maybeWarnForUpdate, () => {
|
||||
let spy: { [key: string]: jest.SpyInstance } = {};
|
||||
|
||||
beforeEach(() => {
|
||||
spy = {
|
||||
warning: jest.spyOn(core, 'warning').mockImplementation(),
|
||||
resolveVersion: jest.spyOn(packager, 'resolveVersion').mockImplementation(),
|
||||
};
|
||||
});
|
||||
|
||||
afterAll(() => {
|
||||
spy.warning.mockRestore();
|
||||
spy.resolveVersion.mockRestore();
|
||||
});
|
||||
|
||||
it('is silent when major version is up to date', async () => {
|
||||
spy.resolveVersion.mockResolvedValueOnce('4.1.0').mockResolvedValueOnce('4.0.1');
|
||||
await tools.maybeWarnForUpdate('eas-cli');
|
||||
expect(spy.warning).not.toBeCalled();
|
||||
});
|
||||
|
||||
it('warns when major version is outdated', async () => {
|
||||
spy.resolveVersion.mockResolvedValueOnce('4.1.0').mockResolvedValueOnce('3.0.1');
|
||||
await tools.maybeWarnForUpdate('expo-cli');
|
||||
expect(spy.warning).toBeCalledWith('There is a new major version available of the Expo CLI (4.1.0)');
|
||||
expect(spy.warning).toBeCalledWith('If you run into issues, try upgrading your workflow to "expo-version: 4.x"');
|
||||
});
|
||||
});
|
||||
|
||||
describe(tools.handleError, () => {
|
||||
let spy: { [key: string]: jest.SpyInstance } = {};
|
||||
|
||||
beforeEach(() => {
|
||||
spy = {
|
||||
setFailed: jest.spyOn(core, 'setFailed').mockImplementation(),
|
||||
resolveVersion: jest.spyOn(packager, 'resolveVersion').mockImplementation(),
|
||||
};
|
||||
});
|
||||
|
||||
afterAll(() => {
|
||||
spy.setFailed.mockRestore();
|
||||
spy.resolveVersion.mockRestore();
|
||||
});
|
||||
|
||||
it('marks the job as failed with expo-cli', async () => {
|
||||
const error = new Error('test');
|
||||
spy.resolveVersion.mockResolvedValue('4.0.0');
|
||||
await tools.handleError('expo-cli', error);
|
||||
expect(core.setFailed).toBeCalledWith(error);
|
||||
});
|
||||
|
||||
it('fails with original error when update warning failed', async () => {
|
||||
const error = new Error('test');
|
||||
spy.resolveVersion.mockRejectedValue(new Error('npm issue'));
|
||||
await tools.handleError('eas-cli', error);
|
||||
expect(core.setFailed).toBeCalledWith(error);
|
||||
});
|
||||
});
|
||||
|
||||
describe(tools.performAction, () => {
|
||||
it('skips the test in a jest environment', async () => {
|
||||
utils.setEnv('JEST_WORKER_ID', '69');
|
||||
const action = jest.fn();
|
||||
const result = await tools.performAction(action);
|
||||
expect(result).toBeNull();
|
||||
expect(action).not.toBeCalled();
|
||||
utils.restoreEnv();
|
||||
});
|
||||
|
||||
it('runs the test outside a jest environment', async () => {
|
||||
utils.setEnv('JEST_WORKER_ID', '');
|
||||
const action = jest.fn();
|
||||
const result = await tools.performAction(action);
|
||||
expect(result).toBeUndefined();
|
||||
expect(action).toBeCalled();
|
||||
utils.restoreEnv();
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,58 @@
|
||||
import * as core from '@actions/core';
|
||||
|
||||
// keep track of the original one to revert the platform
|
||||
const originalPlatform = process.platform;
|
||||
|
||||
/**
|
||||
* Change the node platform for testing purposes.
|
||||
* With this you can fake the `process.platform`.
|
||||
*/
|
||||
export function setPlatform(platform: NodeJS.Platform): void {
|
||||
Object.defineProperty(process, 'platform', { value: platform });
|
||||
}
|
||||
|
||||
/**
|
||||
* Revert the platform to the original one.
|
||||
*/
|
||||
export function restorePlatform(): void {
|
||||
setPlatform(originalPlatform);
|
||||
}
|
||||
|
||||
// keep track of the original environment variables
|
||||
const originalEnv = { ...process.env };
|
||||
|
||||
/**
|
||||
* Change the environment variable for testing purposes.
|
||||
*/
|
||||
export function setEnv(name: string, value: string): void {
|
||||
process.env[name] = value;
|
||||
}
|
||||
|
||||
/**
|
||||
* Revert the environment variable changes.
|
||||
*/
|
||||
export function restoreEnv(): void {
|
||||
process.env = originalEnv;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a mocked version of the tools.
|
||||
*/
|
||||
export function getToolsMock() {
|
||||
return {
|
||||
getBinaryName: jest.fn(v => v.replace('-cli', '')),
|
||||
maybeAuthenticate: jest.fn(),
|
||||
maybePatchWatchers: jest.fn(),
|
||||
maybeWarnForUpdate: jest.fn(),
|
||||
handleError: jest.fn(),
|
||||
performAction: jest.fn(),
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Mock both the input and boolean input methods from `@actions/core`.
|
||||
*/
|
||||
export function mockInput(inputs: Record<string, string> = {}) {
|
||||
jest.spyOn(core, 'getInput').mockImplementation(name => inputs[name]);
|
||||
jest.spyOn(core, 'getBooleanInput').mockImplementation(name => inputs[name] === 'true');
|
||||
}
|
||||
@@ -0,0 +1,13 @@
|
||||
{
|
||||
"extends": "./node_modules/@tsconfig/node16/tsconfig.json",
|
||||
"compilerOptions": {
|
||||
"outDir": "./build",
|
||||
"rootDir": "./src",
|
||||
"useUnknownInCatchVariables": false
|
||||
},
|
||||
"exclude": [
|
||||
"build",
|
||||
"node_modules",
|
||||
"tests/**"
|
||||
]
|
||||
}
|
||||
Reference in new issue
Block a user