Compare commits

..
21 Commits
Author SHA1 Message Date
semantic-release-bot d4175ed947 chore: create new release 7.0.3
### [7.0.3](https://github.com/expo/expo-github-action/compare/7.0.2...7.0.3) (2022-02-14)

### Bug fixes

* improve invalid package version error handling ([#159](https://github.com/expo/expo-github-action/issues/159)) ([94c7d8a](https://github.com/expo/expo-github-action/commit/94c7d8acbd68c7dac4ecde503427c98849039499))
* output error stacktraces in debug mode ([#160](https://github.com/expo/expo-github-action/issues/160)) ([6931e3c](https://github.com/expo/expo-github-action/commit/6931e3c78b432c1b94d84e684da42ecba46044b4))

### Other chores

* always dry run a new release on merge ([#162](https://github.com/expo/expo-github-action/issues/162)) ([3f293ee](https://github.com/expo/expo-github-action/commit/3f293ee480f9d567c1c902848d26a5ca6720266b))
* bump node-fetch from 2.6.1 to 2.6.7 ([#157](https://github.com/expo/expo-github-action/issues/157)) ([839215f](https://github.com/expo/expo-github-action/commit/839215f036182d3534f9b91d4573b9f126f56560))
* fully automate releases ([#164](https://github.com/expo/expo-github-action/issues/164)) ([fbd4450](https://github.com/expo/expo-github-action/commit/fbd44501d896448c3c4ac4e5495bb536614fa3fc))

### Documentation changes

* simplify expo cli versioning to latest ([#161](https://github.com/expo/expo-github-action/issues/161)) ([2e1fe6a](https://github.com/expo/expo-github-action/commit/2e1fe6ac53c6fd536ea5691410d73df35384fd07))
2022-02-14 15:46:00 +00:00
Cedric van Putten fbd44501d8 chore: fully automate releases (#164) 2022-02-14 07:37:49 -08:00
Cedric van Putten 6931e3c78b fix: output error stacktraces in debug mode (#160)
* chore: add test case to output stack traces

* fix: add error stacktraces to debug
2022-02-14 07:20:19 -08:00
Cedric van Putten 3f293ee480 chore: always dry run a new release on merge (#162) 2022-02-14 07:12:36 -08:00
Cedric van Putten 2e1fe6ac53 docs: simplify expo cli versioning to latest (#161) 2022-02-14 07:06:13 -08:00
Cedric van Putten 94c7d8acbd fix: improve invalid package version error handling (#159)
* chore: add test case for invalid package versions

* fix: add improved errors for invalid package versions
2022-02-14 07:01:16 -08:00
dependabot[bot]andCedric van Putten 839215f036 chore: bump node-fetch from 2.6.1 to 2.6.7 (#157)
* chore: bump node-fetch from 2.6.1 to 2.6.7

Bumps [node-fetch](https://github.com/node-fetch/node-fetch) from 2.6.1 to 2.6.7.
- [Release notes](https://github.com/node-fetch/node-fetch/releases)
- [Commits](https://github.com/node-fetch/node-fetch/compare/v2.6.1...v2.6.7)

---
updated-dependencies:
- dependency-name: node-fetch
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <[email protected]>

* chore: rebuild project

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Cedric van Putten <[email protected]>
2022-01-25 19:00:07 +01:00
semantic-release-bot d0148023e1 chore: create new release 7.0.2
### [7.0.2](https://github.com/expo/expo-github-action/compare/7.0.1...7.0.2) (2022-01-25)

### Code changes

* **preview-comment:** auto-fill the github token ([#156](https://github.com/expo/expo-github-action/issues/156)) ([204dfed](https://github.com/expo/expo-github-action/commit/204dfed23cb6416041ee5c918c7a6e3a5dbf8955))
2022-01-25 16:49:29 +00:00
Cedric van Putten 204dfed23c refactor(preview-comment): auto-fill the github token (#156)
* refactor(preview-comment): auto-fill the github token

* refactor; run tests on every pull request

* refactor: reword comment on pr tests
2022-01-25 17:47:49 +01:00
semantic-release-bot 109c3edde0 chore: create new release 7.0.1
### [7.0.1](https://github.com/expo/expo-github-action/compare/7.0.0...7.0.1) (2022-01-17)

### Bug fixes

* remove double resolving package versions ([#152](https://github.com/expo/expo-github-action/issues/152)) ([d53d38f](https://github.com/expo/expo-github-action/commit/d53d38f65bc6add70cdb1eb0fb1caadd3eae9ae4))

### Other chores

* run test workflow every day at 15:00 utc ([fd33d59](https://github.com/expo/expo-github-action/commit/fd33d597d339279a12768e1b3c99e051324dc8ba))

### Documentation changes

* explicitly add non interactive flag ([#151](https://github.com/expo/expo-github-action/issues/151)) ([844ea09](https://github.com/expo/expo-github-action/commit/844ea09678511192c3685351e3eedd0c92dd4d7d))
* update comment preview readme header ([7a46a49](https://github.com/expo/expo-github-action/commit/7a46a499ece6b413f5c6fb05951606c95546e03e))
* update step title in example with eas cli ([7934883](https://github.com/expo/expo-github-action/commit/79348837ee612ad7393e64b3ed04a93519982fe6))
* update workflow badge with test status ([99593b8](https://github.com/expo/expo-github-action/commit/99593b87875c2d5cb38c2b111cf8bdf85ab54b1c))
2022-01-17 20:36:51 +00:00
Cedric van Putten d53d38f65b fix: remove double resolving package versions (#152) 2022-01-17 21:20:52 +01:00
Cedric van Putten 79348837ee docs: update step title in example with eas cli 2022-01-16 09:51:25 -08:00
Cedric van Putten 7a46a499ec docs: update comment preview readme header 2022-01-16 18:48:19 +01:00
Cedric van Putten 844ea09678 docs: explicitly add non interactive flag (#151)
* docs: explicitly add non interactive flag

* docs: explicitly add non interactive flag on preview comment
2022-01-16 09:44:32 -08:00
Cedric van Putten 99593b8787 docs: update workflow badge with test status 2022-01-16 09:35:47 -08:00
Cedric van Putten fd33d597d3 chore: run test workflow every day at 15:00 utc 2022-01-16 09:27:49 -08:00
semantic-release-bot d50f5ddc11 chore: create new release 7.0.0
## [7.0.0](https://github.com/expo/expo-github-action/compare/6.0.0...7.0.0) (2022-01-15)

### ⚠ BREAKING CHANGES

* some input options are deprecated
  - Username and password authentication is dropped in favor of tokens
  - Custom cache keys are dropped
  - Custom install error handler is dropped

### New features

* add comment qr code subaction ([#149](https://github.com/expo/expo-github-action/issues/149)) ([4648212](https://github.com/expo/expo-github-action/commit/464821230fc5d4c4d848dcf20c5146bf99fd38ce))

### Bug fixes

* use which instead of npx to authenticate ([#147](https://github.com/expo/expo-github-action/issues/147)) ([c5d2c0f](https://github.com/expo/expo-github-action/commit/c5d2c0f8c034b625147bc4b2ccd6d14a29412a1d))

### Code changes

* allow multiple entrypoints for different sub-actions ([#121](https://github.com/expo/expo-github-action/issues/121)) ([8a7306a](https://github.com/expo/expo-github-action/commit/8a7306a97854f9b2853a614d3302061922471a8f))
* clean up setup action ([#146](https://github.com/expo/expo-github-action/issues/146)) ([439ff4c](https://github.com/expo/expo-github-action/commit/439ff4c9aa508ea6f38364859109267d8f26fcf1))
* enable caches by default ([#148](https://github.com/expo/expo-github-action/issues/148)) ([72d4067](https://github.com/expo/expo-github-action/commit/72d406754f3b10aeff9b54a2b3e3e833d4cd3c9f))
* replace libnpm with npm cli ([#139](https://github.com/expo/expo-github-action/issues/139)) ([4f28493](https://github.com/expo/expo-github-action/commit/4f28493708de28b8eebd418702ec8eb93660927d))
* roll back to ncc because of swc bundling issues ([#144](https://github.com/expo/expo-github-action/issues/144)) ([3007741](https://github.com/expo/expo-github-action/commit/3007741466570f1bf8f3cf7417e56c7aab50b60a))
* update the outdated workflows and use node 16 ([#138](https://github.com/expo/expo-github-action/issues/138)) ([3134e26](https://github.com/expo/expo-github-action/commit/3134e26b3a41fcc058c60c0f34f87c8d44189d3c))
* upgrade to node 16 github actions runtime ([#137](https://github.com/expo/expo-github-action/issues/137)) ([3bf9181](https://github.com/expo/expo-github-action/commit/3bf9181edb0df2dcaf9112b50c9d2a9996db8a32))
* use assert instead of if statements ([#150](https://github.com/expo/expo-github-action/issues/150)) ([e4ef6e6](https://github.com/expo/expo-github-action/commit/e4ef6e6950f602a6277c6e35dbd36ca3fa8ccb8e))
* use boolean input instead of manual conversion ([#127](https://github.com/expo/expo-github-action/issues/127)) ([f1fe877](https://github.com/expo/expo-github-action/commit/f1fe8775927c95727008dfe31f580c122913a745))
* use spaces for indentation ([#126](https://github.com/expo/expo-github-action/issues/126)) ([ff2ff0f](https://github.com/expo/expo-github-action/commit/ff2ff0f980f70d0047d10637dd5ef915128199ec))
* use swc pack instead of ncc ([#140](https://github.com/expo/expo-github-action/issues/140)) ([3f9e947](https://github.com/expo/expo-github-action/commit/3f9e9479631f03a941ecfebdcd0351ef57f59a2e))

### Other chores

* add basic e2e test workflow for main action ([#141](https://github.com/expo/expo-github-action/issues/141)) ([414c169](https://github.com/expo/expo-github-action/commit/414c1693e6183ad92723fca4517181b21f93eaf0))
* add manual trigger to the tests ([4908a48](https://github.com/expo/expo-github-action/commit/4908a48f1b5e1ccff9589c0fcaafe4223d53bee1))
* always use lf for build files ([#122](https://github.com/expo/expo-github-action/issues/122)) ([a9b9cfe](https://github.com/expo/expo-github-action/commit/a9b9cfef50ba2c1d38fff1a679c554eb52edc25e))
* bump semver-regex from 3.1.2 to 3.1.3 ([#114](https://github.com/expo/expo-github-action/issues/114)) ([50c0ef9](https://github.com/expo/expo-github-action/commit/50c0ef9028d51bd25197c54102438f494c265438))
* bump tar from 4.4.13 to 4.4.19 ([#112](https://github.com/expo/expo-github-action/issues/112)) ([5f5673b](https://github.com/expo/expo-github-action/commit/5f5673ba7744a05d9c499fbca7b4e503aabef5a1))
* bump tmpl from 1.0.4 to 1.0.5 ([#115](https://github.com/expo/expo-github-action/issues/115)) ([92ec93f](https://github.com/expo/expo-github-action/commit/92ec93fa37744783ec10149e7d755d7181649f8a))
* clean up dependencies and eslint rules ([#145](https://github.com/expo/expo-github-action/issues/145)) ([3ae7999](https://github.com/expo/expo-github-action/commit/3ae799926e78cfecd54e965c77d1c1fb49cac45b))
* clean up master references in release and workflows ([#104](https://github.com/expo/expo-github-action/issues/104)) ([a2d9b1c](https://github.com/expo/expo-github-action/commit/a2d9b1cadf463af1e6b4025af3edc99cf7f4b5a0))
* clean up tsconfig and eslint rules ([#123](https://github.com/expo/expo-github-action/issues/123)) ([c20146f](https://github.com/expo/expo-github-action/commit/c20146f3b7513ae3a3df3dead651d2a2dea988af))
* lint root files with prettier and eslint ([#125](https://github.com/expo/expo-github-action/issues/125)) ([1cfa7bb](https://github.com/expo/expo-github-action/commit/1cfa7bbd9ed623e2e40406addab4bff2c9a7b2fd))
* rebuild project ([45b79a0](https://github.com/expo/expo-github-action/commit/45b79a05ef7496339d33d03fdd7755ef76c7038b))
* rebuild project after dependency bumps ([b099f17](https://github.com/expo/expo-github-action/commit/b099f17d588e23df069b60d39ca1e21327066a4f))
* remove husky and improve ci build message ([#128](https://github.com/expo/expo-github-action/issues/128)) ([39b0d36](https://github.com/expo/expo-github-action/commit/39b0d361f7d97ef1a71a02495463d1e93a72093a))
* simplify review and update build detection ([#142](https://github.com/expo/expo-github-action/issues/142)) ([ee415b0](https://github.com/expo/expo-github-action/commit/ee415b027afce4c15cabcc6fa2f8368530a36c08))
* update `setup-node` action to `v2` release ([#119](https://github.com/expo/expo-github-action/issues/119)) ([3b3e6b8](https://github.com/expo/expo-github-action/commit/3b3e6b8031b898cdf0bc59488d541d90748954b9))
* update semantic release to update the build ([354dc08](https://github.com/expo/expo-github-action/commit/354dc0891761b8d1fc092ec5e9bb3b5ca1922090))
* update the action manifest ([633cdf0](https://github.com/expo/expo-github-action/commit/633cdf0ac9f283f5a7010fef11bfda9174278054))
* upgrade dev dependencies and rebuild action ([#120](https://github.com/expo/expo-github-action/issues/120)) ([186ef00](https://github.com/expo/expo-github-action/commit/186ef0011a259a7b2c745f8cf2743358ca112530))

### Documentation changes

* fix broken sup element in readme ([0b1822a](https://github.com/expo/expo-github-action/commit/0b1822a93580171a0582013a0cf7848cf3503ed7))
* fix github capitalization ([#116](https://github.com/expo/expo-github-action/issues/116)) ([b602469](https://github.com/expo/expo-github-action/commit/b60246939fba50e600b11596b4b1029091017b7c))
* fix unsplash comment on pr branch reference ([#110](https://github.com/expo/expo-github-action/issues/110)) ([f14253e](https://github.com/expo/expo-github-action/commit/f14253ea9c17296e843610c7b8fad4e13c7abda0))
* update default values in readme ([c2f11d2](https://github.com/expo/expo-github-action/commit/c2f11d2d513b75ec0a00c6bf60e5d0e275c3a8af))
* update expo.io links to expo.dev ([#111](https://github.com/expo/expo-github-action/issues/111)) ([1c8e5a2](https://github.com/expo/expo-github-action/commit/1c8e5a21e9689cedd8fbcf61e50a3f4700b6bc41))
* update node version reference in readme ([#107](https://github.com/expo/expo-github-action/issues/107)) ([3ba667b](https://github.com/expo/expo-github-action/commit/3ba667b43f1e103a1c64e92a60d7c36bd0ad10b2))
* update readme and contributing guides ([521de72](https://github.com/expo/expo-github-action/commit/521de724fcb79235773c077e870d7c2293ab51cb))
* use `main` branch to update `v{major}` tag ([#103](https://github.com/expo/expo-github-action/issues/103)) ([def44e2](https://github.com/expo/expo-github-action/commit/def44e2c77a39f5bd48dbb07adec509137afcf67))
2022-01-15 15:47:12 +00:00
Cedric van Putten e4ef6e6950 refactor: use assert instead of if statements (#150)
* refactor: use assert instead of if statements

* chore: rebuild project
2022-01-15 16:44:22 +01:00
Cedric van Putten 464821230f feature: add comment qr code subaction (#149)
* feature: add comment subaction for qr code previews

* chore: rebuild project

* chore: setup test for comment subaction

* fix: add missing metadata for the comment subaction

* fix: path to entrypoint in comment subaction

* fix: add test overwrite

* fix: resolve the owner silently

* fix: avoid double error: in failed actions

* fix: add missing github token

* chore: rebuild project

* chore: rebuild project

* fix: newline in project owner

* feature: add outputs to allow customization and rename

* fix: failing test

* chore: rebuild project

* chore: tweak the comment a bit more

* docs: add documentation for preview comment

* docs: add message about comment message id

* docs: fix typo in output reuse

* docs: add missing message id to outputs

* docs: make steps a bit more readable

* docs: update github actions version

* chore: make test workflow more readable

* test: add missing comment preview tests

* chore: rebuild project

* test: separate each output

* docs: update readme

* chore: remove unnecessary comments

* docs: use new table format

* docs: update name to match value in actions

* docs: use relative path to preview-comment action

* fix: use project owner in default comment id

* docs: move unimportant stuff around

* docs: last pass over readmes
2022-01-15 16:30:49 +01:00
Cedric van Putten 354dc08917 chore: update semantic release to update the build 2022-01-13 22:26:31 +01:00
Cedric van Putten c2f11d2d51 docs: update default values in readme 2022-01-13 22:18:12 +01:00
25 changed files with 20710 additions and 313 deletions

No files matched your search

+55 -9
View File
@@ -1,6 +1,8 @@
name: release
on:
push:
branches: [main]
workflow_dispatch:
inputs:
release:
@@ -11,11 +13,9 @@ concurrency:
group: release
cancel-in-progress: true
env:
release: ${{ github.ref == 'refs/heads/main' && github.event.inputs.release == 'release' }}
jobs:
release:
dryrun:
if: ${{ github.ref != 'refs/heads/main' || github.event.inputs.release != 'release' }}
runs-on: ubuntu-latest
steps:
- name: 🏗 Setup repo
@@ -28,16 +28,62 @@ jobs:
cache: yarn
- name: 📦 Install dependencies
run: yarn install --frozen-lockfile --check-files
run: yarn install --frozen-lockfile
- name: 📋 Dry-running release
if: ${{ !env.release }}
run: yarn semantic-release --dry-run
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GITHUB_TOKEN: ${{ github.token }}
publish:
if: ${{ github.ref == 'refs/heads/main' && github.event.inputs.release == '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
- name: 📋 Release code
if: ${{ env.release }}
run: yarn semantic-release
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GITHUB_TOKEN: ${{ github.token }}
tags:
needs: publish
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
- name: 📦 Install semver
run: yarn add --dev semver
- name: 🕵️ Resolve major version
uses: actions/github-script@v6
id: version
with:
result-encoding: string
script: |
const semver = require('semver')
const { version } = require('./package.json')
return semver.major(version)
- name: 📋 Update tags
run: git tag --force v${{ steps.version.outputs.result }} && git push --force --tags
+57 -5
View File
@@ -1,8 +1,12 @@
name: test
on:
schedule:
- cron: '0 15 * * *'
push:
branches: [main]
pull_request:
types: [opened, synchronize]
workflow_dispatch:
concurrency:
@@ -14,12 +18,11 @@ jobs:
strategy:
matrix:
os:
- macos-latest
- ubuntu-latest
- windows-latest
cache:
- true
- false
- with-cache
- without-cache
runs-on: ${{ matrix.os }}
steps:
- name: 🏗 Setup repo
@@ -29,9 +32,9 @@ jobs:
uses: ./
with:
eas-version: latest
eas-cache: ${{ matrix.cache }}
eas-cache: ${{ matrix.cache == 'with-cache' }}
expo-version: latest
expo-cache: ${{ matrix.cache }}
expo-cache: ${{ matrix.cache == 'with-cache' }}
token: ${{ secrets.EXPO_TOKEN }}
- name: 🧪 EAS installed
@@ -45,4 +48,53 @@ jobs:
- name: 🧪 Expo authenticated
run: expo whoami
preview-comment:
runs-on: ubuntu-latest
steps:
- name: 🏗 Setup repo
uses: actions/checkout@v2
- name: 🏗 Setup Expo
uses: ./
with:
eas-version: latest
expo-version: latest
token: ${{ secrets.EXPO_TOKEN }}
- name: 🏗 Setup project
run: expo init -t blank ./temp
- name: 🧪 Without commenting
uses: ./preview-comment
id: preview
with:
project: ./temp
comment: false
- name: 🧪 Output has content
uses: actions/github-script@v5
with:
script: |
const message = `${{ steps.preview.outputs.message }}`
if (!message) throw new Error('Message output is empty')
- name: 🧪 Comment on PR (github-token)
uses: ./preview-comment
env:
EXPO_TEST_GITHUB_PULL: 149
with:
project: ./temp
channel: test
- name: 🧪 Comment on PR (GITHUB_TOKEN)
uses: ./preview-comment
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
EXPO_TEST_GITHUB_PULL: 149
with:
project: ./temp
channel: test
github-token: badtoken
+2 -1
View File
@@ -34,9 +34,10 @@ module.exports = {
}],
'@semantic-release/changelog',
['@semantic-release/npm', { npmPublish: false }],
["@semantic-release/exec", { publishCmd: 'yarn build' }],
['@semantic-release/git', {
message: 'chore: create new release ${nextRelease.version}\n\n${nextRelease.notes}',
assets: ['package.json', 'CHANGELOG.md'],
assets: ['package.json', 'CHANGELOG.md', 'build/*'],
}],
'@semantic-release/github',
],
+56 -1
View File
@@ -1,4 +1,51 @@
## [7.0.0](https://github.com/expo/expo-github-action/compare/6.0.0...7.0.0) (2022-01-13)
### [7.0.3](https://github.com/expo/expo-github-action/compare/7.0.2...7.0.3) (2022-02-14)
### Bug fixes
* improve invalid package version error handling ([#159](https://github.com/expo/expo-github-action/issues/159)) ([94c7d8a](https://github.com/expo/expo-github-action/commit/94c7d8acbd68c7dac4ecde503427c98849039499))
* output error stacktraces in debug mode ([#160](https://github.com/expo/expo-github-action/issues/160)) ([6931e3c](https://github.com/expo/expo-github-action/commit/6931e3c78b432c1b94d84e684da42ecba46044b4))
### Other chores
* always dry run a new release on merge ([#162](https://github.com/expo/expo-github-action/issues/162)) ([3f293ee](https://github.com/expo/expo-github-action/commit/3f293ee480f9d567c1c902848d26a5ca6720266b))
* bump node-fetch from 2.6.1 to 2.6.7 ([#157](https://github.com/expo/expo-github-action/issues/157)) ([839215f](https://github.com/expo/expo-github-action/commit/839215f036182d3534f9b91d4573b9f126f56560))
* fully automate releases ([#164](https://github.com/expo/expo-github-action/issues/164)) ([fbd4450](https://github.com/expo/expo-github-action/commit/fbd44501d896448c3c4ac4e5495bb536614fa3fc))
### Documentation changes
* simplify expo cli versioning to latest ([#161](https://github.com/expo/expo-github-action/issues/161)) ([2e1fe6a](https://github.com/expo/expo-github-action/commit/2e1fe6ac53c6fd536ea5691410d73df35384fd07))
### [7.0.2](https://github.com/expo/expo-github-action/compare/7.0.1...7.0.2) (2022-01-25)
### Code changes
* **preview-comment:** auto-fill the github token ([#156](https://github.com/expo/expo-github-action/issues/156)) ([204dfed](https://github.com/expo/expo-github-action/commit/204dfed23cb6416041ee5c918c7a6e3a5dbf8955))
### [7.0.1](https://github.com/expo/expo-github-action/compare/7.0.0...7.0.1) (2022-01-17)
### Bug fixes
* remove double resolving package versions ([#152](https://github.com/expo/expo-github-action/issues/152)) ([d53d38f](https://github.com/expo/expo-github-action/commit/d53d38f65bc6add70cdb1eb0fb1caadd3eae9ae4))
### Other chores
* run test workflow every day at 15:00 utc ([fd33d59](https://github.com/expo/expo-github-action/commit/fd33d597d339279a12768e1b3c99e051324dc8ba))
### Documentation changes
* explicitly add non interactive flag ([#151](https://github.com/expo/expo-github-action/issues/151)) ([844ea09](https://github.com/expo/expo-github-action/commit/844ea09678511192c3685351e3eedd0c92dd4d7d))
* update comment preview readme header ([7a46a49](https://github.com/expo/expo-github-action/commit/7a46a499ece6b413f5c6fb05951606c95546e03e))
* update step title in example with eas cli ([7934883](https://github.com/expo/expo-github-action/commit/79348837ee612ad7393e64b3ed04a93519982fe6))
* update workflow badge with test status ([99593b8](https://github.com/expo/expo-github-action/commit/99593b87875c2d5cb38c2b111cf8bdf85ab54b1c))
## [7.0.0](https://github.com/expo/expo-github-action/compare/6.0.0...7.0.0) (2022-01-15)
### ⚠ BREAKING CHANGES
@@ -8,6 +55,11 @@
- Custom cache keys are dropped
- Custom install error handler is dropped
### New features
* add comment qr code subaction ([#149](https://github.com/expo/expo-github-action/issues/149)) ([4648212](https://github.com/expo/expo-github-action/commit/464821230fc5d4c4d848dcf20c5146bf99fd38ce))
### Bug fixes
* use which instead of npx to authenticate ([#147](https://github.com/expo/expo-github-action/issues/147)) ([c5d2c0f](https://github.com/expo/expo-github-action/commit/c5d2c0f8c034b625147bc4b2ccd6d14a29412a1d))
@@ -22,6 +74,7 @@
* roll back to ncc because of swc bundling issues ([#144](https://github.com/expo/expo-github-action/issues/144)) ([3007741](https://github.com/expo/expo-github-action/commit/3007741466570f1bf8f3cf7417e56c7aab50b60a))
* update the outdated workflows and use node 16 ([#138](https://github.com/expo/expo-github-action/issues/138)) ([3134e26](https://github.com/expo/expo-github-action/commit/3134e26b3a41fcc058c60c0f34f87c8d44189d3c))
* upgrade to node 16 github actions runtime ([#137](https://github.com/expo/expo-github-action/issues/137)) ([3bf9181](https://github.com/expo/expo-github-action/commit/3bf9181edb0df2dcaf9112b50c9d2a9996db8a32))
* use assert instead of if statements ([#150](https://github.com/expo/expo-github-action/issues/150)) ([e4ef6e6](https://github.com/expo/expo-github-action/commit/e4ef6e6950f602a6277c6e35dbd36ca3fa8ccb8e))
* use boolean input instead of manual conversion ([#127](https://github.com/expo/expo-github-action/issues/127)) ([f1fe877](https://github.com/expo/expo-github-action/commit/f1fe8775927c95727008dfe31f580c122913a745))
* use spaces for indentation ([#126](https://github.com/expo/expo-github-action/issues/126)) ([ff2ff0f](https://github.com/expo/expo-github-action/commit/ff2ff0f980f70d0047d10637dd5ef915128199ec))
* use swc pack instead of ncc ([#140](https://github.com/expo/expo-github-action/issues/140)) ([3f9e947](https://github.com/expo/expo-github-action/commit/3f9e9479631f03a941ecfebdcd0351ef57f59a2e))
@@ -44,6 +97,7 @@
* remove husky and improve ci build message ([#128](https://github.com/expo/expo-github-action/issues/128)) ([39b0d36](https://github.com/expo/expo-github-action/commit/39b0d361f7d97ef1a71a02495463d1e93a72093a))
* simplify review and update build detection ([#142](https://github.com/expo/expo-github-action/issues/142)) ([ee415b0](https://github.com/expo/expo-github-action/commit/ee415b027afce4c15cabcc6fa2f8368530a36c08))
* update `setup-node` action to `v2` release ([#119](https://github.com/expo/expo-github-action/issues/119)) ([3b3e6b8](https://github.com/expo/expo-github-action/commit/3b3e6b8031b898cdf0bc59488d541d90748954b9))
* update semantic release to update the build ([354dc08](https://github.com/expo/expo-github-action/commit/354dc0891761b8d1fc092ec5e9bb3b5ca1922090))
* update the action manifest ([633cdf0](https://github.com/expo/expo-github-action/commit/633cdf0ac9f283f5a7010fef11bfda9174278054))
* upgrade dev dependencies and rebuild action ([#120](https://github.com/expo/expo-github-action/issues/120)) ([186ef00](https://github.com/expo/expo-github-action/commit/186ef0011a259a7b2c745f8cf2743358ca112530))
@@ -53,6 +107,7 @@
* fix broken sup element in readme ([0b1822a](https://github.com/expo/expo-github-action/commit/0b1822a93580171a0582013a0cf7848cf3503ed7))
* fix github capitalization ([#116](https://github.com/expo/expo-github-action/issues/116)) ([b602469](https://github.com/expo/expo-github-action/commit/b60246939fba50e600b11596b4b1029091017b7c))
* fix unsplash comment on pr branch reference ([#110](https://github.com/expo/expo-github-action/issues/110)) ([f14253e](https://github.com/expo/expo-github-action/commit/f14253ea9c17296e843610c7b8fad4e13c7abda0))
* update default values in readme ([c2f11d2](https://github.com/expo/expo-github-action/commit/c2f11d2d513b75ec0a00c6bf60e5d0e275c3a8af))
* update expo.io links to expo.dev ([#111](https://github.com/expo/expo-github-action/issues/111)) ([1c8e5a2](https://github.com/expo/expo-github-action/commit/1c8e5a21e9689cedd8fbcf61e50a3f4700b6bc41))
* update node version reference in readme ([#107](https://github.com/expo/expo-github-action/issues/107)) ([3ba667b](https://github.com/expo/expo-github-action/commit/3ba667b43f1e103a1c64e92a60d7c36bd0ad10b2))
* update readme and contributing guides ([521de72](https://github.com/expo/expo-github-action/commit/521de724fcb79235773c077e870d7c2293ab51cb))
+100 -107
View File
@@ -1,68 +1,64 @@
<div align="center">
<h1>expo github action</h1>
<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" />
<img src="https://img.shields.io/github/v/release/expo/expo-github-action" alt="releases" />
</a>
<a href="https://github.com/expo/expo-github-action/actions">
<img src="https://img.shields.io/github/workflow/status/expo/expo-github-action/CI/main.svg?style=flat-square" alt="builds" />
<img src="https://img.shields.io/github/workflow/status/expo/expo-github-action/test" alt="builds" />
</a>
<a href="https://github.com/expo/expo-github-action/blob/main/LICENSE.md">
<img src="https://img.shields.io/github/license/expo/expo-github-action?style=flat-square" alt="license" />
<img src="https://img.shields.io/github/license/expo/expo-github-action" alt="license" />
</a>
</p>
<p align="center">
<a href="https://github.com/expo/expo-github-action#configuration-options"><b>Usage</b></a>
<a href="#configuration-options"><b>Usage</b></a>
&nbsp;&nbsp;&mdash;&nbsp;&nbsp;
<a href="https://github.com/expo/expo-github-action#example-workflows"><b>Examples</b></a>
<a href="#example-workflows"><b>Examples</b></a>
&nbsp;&nbsp;&mdash;&nbsp;&nbsp;
<a href="https://github.com/expo/expo-github-action#things-to-know"><b>Caveats</b></a>
<a href="#things-to-know"><b>Caveats</b></a>
&nbsp;&nbsp;&mdash;&nbsp;&nbsp;
<a href="https://github.com/expo/expo-github-action/blob/main/CHANGELOG.md"><b>Changelog</b></a>
<a href="/blob/main/CHANGELOG.md"><b>Changelog</b></a>
</p>
</div>
## What's inside?
With this Expo action, you have full access to [Expo CLI][link-expo-cli] and [EAS CLI][link-eas-cli].
It allows you to fully automate the `expo publish` or `eas 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.
It lets you automate the `expo publish` or `eas build` commands, leaving you with more time to work on your project.
Some additional features are included to make the usage of this action as simple as possible, like caching and authentication.
## Configuration options
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.
This action is customizable through variables defined in the [`action.yml`](action.yml).
Here is a summary of all the input options you can use.
| variable | default | description |
| ---------------- | ------- | ------------------------------------------------------------------------------------ |
| `expo-version` | `''` | [Expo CLI](https://github.com/expo/expo-cli) version to install, skips when omitted. |
| `expo-cache` | `true` | If it should use the [GitHub actions cache](#using-the-built-in-cache). |
| `eas-version` | `''` | [EAS CLI](https://github.com/expo/eas-cli) version to install, skips when omitted. |
| `eas-cache` | `true` | If it should use the [GitHub actions cache](#using-the-built-in-cache). |
| `packager` | `yarn` | The package manager to use. _(e.g. `yarn` or `npm`)_ |
| `token` | `''` | The token of your Expo account |
| `patch-watchers` | `true` | If it should [patch the `fs.inotify.` limits](#enospc-errors-on-linux). |
> Never hardcode `expo-token` in your workflow, use [secrets][link-actions-secrets] to store them.
> Using `latest` for `eas-version` is recommened, you should always have the latest version of this CLI installed.
| variable | default | description |
| ------------------ | ------- | --------------------------------------------------------------------------------------------- |
| **expo-version** | - | Expo CLI version to install _(skips when omitted)_ |
| **expo-cache** | `true` | If it should use the GitHub actions cache ([read more](#using-the-built-in-cache)) |
| **eas-version** | - | EAS CLI version to install _(skips when omitted)_ |
| **eas-cache** | `true` | If it should use the GitHub actions cache ([read more](#using-the-built-in-cache)) |
| **packager** | `yarn` | Package manager to use _(e.g. `yarn` or `npm`)_ |
| **token** | - | Token of your Expo account _(only use with [secrets][link-actions-secrets])_ |
| **patch-watchers** | `true` | If it should patch the `fs.inotify.*` limits on Ubuntu ([read more](#enospc-errors-on-linux)) |
## Example workflows
Before you dive into the workflow examples, you should know the basics of GitHub Actions.
Before diving 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 to main](#publish-on-any-push-to-main)
2. [Creating a new EAS build](#creating-a-new-eas-build)
3. [Test PRs and publish a review version](#test-prs-and-publish-a-review-version)
4. [Test PRs on multiple nodes and systems](#test-prs-on-multiple-node-versions-and-systems)
3. [Publish a preview from PR](#publish-a-preview-from-PR)
### Publish on any push to main
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.
This workflow listens to the `push` event on the `main` branch.
It sets up all required components to publish the app, including authentication with a token.
> Always use [secrets][link-actions-secrets] when using tokens.
```yml
on:
@@ -73,26 +69,35 @@ jobs:
publish:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
- name: 🏗 Setup repo
uses: actions/checkout@v2
- name: 🏗 Setup Node
uses: actions/setup-node@v2
with:
node-version: 16.x
cache: yarn
- uses: expo/expo-github-action@v6
- name: 🏗 Setup Expo
uses: expo/expo-github-action@v7
with:
expo-version: 5.x
expo-version: latest
token: ${{ secrets.EXPO_TOKEN }}
- run: yarn install
- run: expo publish
- name: 📦 Install dependencies
run: yarn install
- name: 🚀 Publish app
run: expo publish --non-interactive
```
### Creating a new EAS build
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.
This action also allows you to install the EAS CLI.
To do this, add the **eas-version** property, and the action will install it.
We recommend using `latest` for the EAS CLI.
> We recommend using `latest` for `eas-version` to always have the most up-to-date version.
> The **token** is shared for both Expo and EAS CLI.
```yml
on:
@@ -103,107 +108,95 @@ jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
- name: 🏗 Setup repo
uses: actions/checkout@v2
- name: 🏗 Setup Node
uses: actions/setup-node@v2
with:
node-version: 16.x
cache: yarn
- uses: expo/expo-github-action@v6
- name: 🏗 Setup Expo and EAS
uses: expo/expo-github-action@v7
with:
expo-version: latest
eas-version: latest
token: ${{ secrets.EXPO_TOKEN }}
- run: yarn install
- run: eas build
- name: 📦 Install dependencies
run: yarn install
- name: 🚀 Build app
run: eas build --non-interactive
```
### Test PRs and publish a review version
### Publish a preview from PR
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.
Reviewing pull requests can take some time.
The reviewer needs to check out the branch, install the changes, and run the bundler to review the results.
You can also automatically publish the project for the reviewer to skip those manual steps.
This workflow publishes the changes on the `pr-#` [release channel][link-expo-release-channels] and adds a comment to the pull request once it's ready for review.
> See the [preview-comment docs](./preview-comment).
```yml
on: [pull_request]
env:
projectOwner: bycedric
projectSlug: use-expo
jobs:
publish:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
- name: 🏗 Setup repo
uses: actions/checkout@v2
- name: 🏗 Setup Node
uses: actions/setup-node@v2
with:
node-version: 16.x
cache: yarn
- uses: expo/expo-github-action@v6
- name: 🏗 Setup Expo
uses: expo/expo-github-action@v7
with:
expo-version: 5.x
expo-version: latest
token: ${{ secrets.EXPO_TOKEN }}
- run: yarn install
- run: expo publish --release-channel=pr-${{ github.event.number }}
- uses: unsplash/[email protected]
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: 📦 Install dependencies
run: yarn install
- name: 🚀 Publish preview
run: expo publish --release-channel=pr-${{ github.event.number }} --non-interactive
- name: 💬 Comment preview
uses: expo/expo-github-action/preview-comment@v7
with:
msg: App is ready for review, you can [see it here](https://expo.dev/@${{ env.projectOwner }}/${{ env.projectSlug }}?release-channel=pr-${{ github.event.number }}).\n\n<img src="https://qr.expo.dev/expo-go?owner=${{ env.projectOwner }}&slug=${{ env.projectSlug }}&releaseChannel=pr-${{ github.event.number }}" height="200px" width="200px"></a>
```
### Test PRs on multiple node versions 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
on: [pull_request]
jobs:
ci:
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ubuntu-latest, macOS-latest, windows-latest]
node: [14.x, 16.x]
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version: ${{ matrix.node }}
cache: yarn
- uses: expo/expo-github-action@v6
with:
expo-version: 5.x
- run: yarn install
- run: yarn test
- run: expo doctor
channel: pr-${{ github.event.number }}
```
## Things to know
### Automatic Expo login
You need to authenticate for some Expo commands like `expo publish` and `expo build`.
This action can export the `EXPO_TOKEN` variable to access it in every step.
Some Expo commands, like `expo publish` and `eas build`, require you to be authenticated.
This action exports the **token** to ensure you are authenticated in every workflow step.
> Note, this action does not store the token anywhere. For every seperate job, you need to setup the token.
> Note, this action does not store the token anywhere. Each separate workflow job needs to set up the **token** individually.
### Using the built-in cache
Caching is enabled by default to speed up consecutive CLI installs, but you can still opt-out to this.
Under the hood, it uses the [`@actions/cache`][link-actions-cache-package] package to restore the CLI installation.
This action generates a unique cache key for the OS, used packager, and exact version of the CLI.
You can opt-out from caching the Expo and EAS CLI installations.
Under the hood, it uses the [`@actions/cache`][link-actions-cache-package] package to restore a previous install.
It reduces the installation time because it only needs to download and extract a single tar file.
> Note, this cache will count towards your [repo cache limit][link-actions-cache-limit]. The Expo and EAS CLI are stored in different caches.
> Note, using cache will count towards your [repo cache limit][link-actions-cache-limit]. Both the Expo and EAS CLI are stored in different caches.
### ENOSPC errors on Linux
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`.
Creating new bundles with Metro can be memory intensive.
In the past, some builds resulted in `ENOSPC` errors.
To prevent anyone from running into this, we make sure Ubuntu has sensible defaults in terms of file system availability.
You can opt-out from patching the file system by setting **patch-watchers** to `false`.
<div align="center">
<br />
@@ -214,8 +207,8 @@ You can disable this patch by setting the `patch-watchers` to `false`.
[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://github.com/actions/toolkit/tree/main/packages/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-release-channels]: https://docs.expo.dev/distribution/release-channels/
[link-eas-cli]: https://github.com/expo/eas-cli#readme
[link-preview-comment]: https://github.com/expo/expo-github-action/pull/149#issuecomment-1013184520
File diff suppressed because it is too large. Load diff
+762
View File
@@ -0,0 +1,762 @@
@actions/core
MIT
The MIT License (MIT)
Copyright 2019 GitHub
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.
@actions/exec
MIT
The MIT License (MIT)
Copyright 2019 GitHub
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.
@actions/github
MIT
The MIT License (MIT)
Copyright 2019 GitHub
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.
@actions/http-client
MIT
Actions Http Client for Node.js
Copyright (c) GitHub, Inc.
All rights reserved.
MIT License
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.
@actions/io
MIT
The MIT License (MIT)
Copyright 2019 GitHub
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.
@actions/tool-cache
MIT
The MIT License (MIT)
Copyright 2019 GitHub
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.
@octokit/auth-token
MIT
The MIT License
Copyright (c) 2019 Octokit contributors
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.
@octokit/core
MIT
The MIT License
Copyright (c) 2019 Octokit contributors
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.
@octokit/endpoint
MIT
The MIT License
Copyright (c) 2018 Octokit contributors
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.
@octokit/graphql
MIT
The MIT License
Copyright (c) 2018 Octokit contributors
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.
@octokit/plugin-paginate-rest
MIT
MIT License Copyright (c) 2019 Octokit contributors
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 (including the next paragraph) 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.
@octokit/plugin-rest-endpoint-methods
MIT
MIT License Copyright (c) 2019 Octokit contributors
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 (including the next paragraph) 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.
@octokit/request
MIT
The MIT License
Copyright (c) 2018 Octokit contributors
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.
@octokit/request-error
MIT
The MIT License
Copyright (c) 2019 Octokit contributors
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.
before-after-hook
Apache-2.0
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "{}"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright 2018 Gregor Martynus and other contributors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
deprecation
ISC
The ISC License
Copyright (c) Gregor Martynus and contributors
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
encoding
MIT
Copyright (c) 2012-2014 Andris Reinman
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 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.
iconv-lite
MIT
Copyright (c) 2011 Alexander Shtuchkin
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.
is-plain-object
MIT
The MIT License (MIT)
Copyright (c) 2014-2017, Jon Schlinkert.
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.
node-fetch
MIT
The MIT License (MIT)
Copyright (c) 2016 David Frank
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.
once
ISC
The ISC License
Copyright (c) Isaac Z. Schlueter and Contributors
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
safer-buffer
MIT
MIT License
Copyright (c) 2018 Nikita Skovoroda <[email protected]>
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.
semver
ISC
The ISC License
Copyright (c) Isaac Z. Schlueter and Contributors
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
tr46
MIT
tunnel
MIT
The MIT License (MIT)
Copyright (c) 2012 Koichi Kobayashi
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.
universal-user-agent
ISC
# [ISC License](https://spdx.org/licenses/ISC)
Copyright (c) 2018, Gregor Martynus (https://github.com/gr2m)
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
uuid
MIT
The MIT License (MIT)
Copyright (c) 2010-2016 Robert Kieffer and other contributors
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.
webidl-conversions
BSD-2-Clause
# The BSD 2-Clause License
Copyright (c) 2014, Domenic Denicola
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
whatwg-url
MIT
The MIT License (MIT)
Copyright (c) 2015–2016 Sebastian Mayr
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.
wrappy
ISC
The ISC License
Copyright (c) Isaac Z. Schlueter and Contributors
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+2362 -67
View File
File diff suppressed because it is too large. Load diff
+44
View File
@@ -952,6 +952,9 @@ Redistribution and use in source and binary forms, with or without modification,
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
tr46
MIT
tslib
0BSD
Copyright (c) Microsoft Corporation.
@@ -1041,6 +1044,47 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
webidl-conversions
BSD-2-Clause
# The BSD 2-Clause License
Copyright (c) 2014, Domenic Denicola
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
whatwg-url
MIT
The MIT License (MIT)
Copyright (c) 2015–2016 Sebastian Mayr
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.
xml2js
MIT
Copyright 2010, 2011, 2012, 2013. All rights reserved.
+3 -1
View File
@@ -1,7 +1,7 @@
{
"private": true,
"name": "expo-github-action",
"version": "7.0.0",
"version": "7.0.3",
"description": "Expo CLI in your GitHub Actions workflow",
"main": "build/index.js",
"repository": {
@@ -24,11 +24,13 @@
"@actions/cache": "^1.0.8",
"@actions/core": "^1.6.0",
"@actions/exec": "^1.1.0",
"@actions/github": "^5.0.0",
"@actions/io": "^1.1.1",
"@actions/tool-cache": "^1.7.1"
},
"devDependencies": {
"@semantic-release/changelog": "^6.0.1",
"@semantic-release/exec": "^6.0.3",
"@semantic-release/git": "^10.0.1",
"@tsconfig/node16": "^1.0.2",
"@types/jest": "^27.4.0",
+189
View File
@@ -0,0 +1,189 @@
<div align="center">
<h1>expo-github-action/preview-comment</h1>
<p>Add <a href="https://github.com/expo/expo">Expo</a> preview comments to pull requests</p>
<p>
<a href="https://github.com/expo/expo-github-action/releases">
<img src="https://img.shields.io/github/v/release/expo/expo-github-action" alt="releases" />
</a>
<a href="https://github.com/expo/expo-github-action/actions">
<img src="https://img.shields.io/github/workflow/status/expo/expo-github-action/test" alt="builds" />
</a>
<a href="https://github.com/expo/expo-github-action/blob/main/LICENSE.md">
<img src="https://img.shields.io/github/license/expo/expo-github-action" alt="license" />
</a>
</p>
<p align="center">
<a href="#configuration-options"><b>Usage</b></a>
&nbsp;&nbsp;&mdash;&nbsp;&nbsp;
<a href="#available-outputs"><b>Outputs</b></a>
&nbsp;&nbsp;&mdash;&nbsp;&nbsp;
<a href="#example-workflows"><b>Examples</b></a>
&nbsp;&nbsp;&mdash;&nbsp;&nbsp;
<a href="#things-to-know"><b>Caveats</b></a>
&nbsp;&nbsp;&mdash;&nbsp;&nbsp;
<a href="https://github.com/expo/expo-github-action/blob/main/CHANGELOG.md"><b>Changelog</b></a>
</p>
</div>
## What's inside?
This (sub)action allows you to comment on pull requests containing Expo QR codes.
It can help speed up the review process by letting the reviewer load the app directly on their phone.
> This action only creates the comment. You still have to publish the project.
## Configuration options
This action is customizable through variables defined in the [`action.yml`](action.yml).
Here is a summary of all the input options you can use.
| variable | default | description |
| -------------- | --------------------------- | ------------------------------------------------------------------------------------------------ |
| **project** | - | The relative path to the Expo project |
| **channel** | `default` | On what channel the project was published |
| **comment** | `true` | If this action should comment on a PR |
| **message** | _[see code][code-defaults]_ | The message template |
| **message-id** | _[see code][code-defaults]_ | A unique id template to prevent duplicate comments ([read more](#preventing-duplicate-comments)) |
| **github-token** | `GITHUB_TOKEN` | A GitHub token to use when commenting on PR ([read more](#github-tokens)) |
## Available outputs
There are a few variables available to generate the comment content.
Some of these variables are also exported as subaction output.
Here is a summary of these variables.
| output name | template name | description |
| ---------------- | ---------------- | ---------------------------------------------------- |
| **projectOwner** | `{projectOwner}` | The resolved owner of the project |
| **projectSlug** | `{projectSlug}` | The resolved slug of the project |
| **projectName** | `{projectName}` | The resolved name of the project |
| **projectLink** | `{projectLink}` | The expo.dev project link, including release channel |
| **projectQR** | `{projectQR}` | The QR code link, to load the project in Expo Go |
| - | `{channel}` | The release channel that was used |
| **message** | - | The resolved message content |
| **messageId** | - | The resolved message id content |
## Example workflows
Before diving 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 and preview on pull request](#publish-and-preview-on-pull-request)
2. [Sending preview comments elsewhere](#sending-preview-comments-elsewhere)
### Publish and preview on pull request
This workflow listens to the `pull_request` event and publishes a to Expo, on release channel `pr-#`.
Once that's done, it will comment with the QR code on that same pull request.
It's essential to keep pull requests separated, by release channel, to avoid writing over pull requests.
```yml
on:
pull_request:
types: [opened, synchronize]
jobs:
preview:
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: 🏗 Setup Expo
uses: expo/expo-github-action@v7
with:
expo-version: 5.x
token: ${{ secrets.EXPO_TOKEN }}
- name: 📦 Install dependencies
run: yarn install
- name: 🚀 Publish to Expo
run: expo publish --release-channel=pr-${{ github.event.number }} --non-interactive
- name: 💬 Comment in preview
uses: expo/expo-github-action/preview-comment@v7
with:
channel: pr-${{ github.event.number }}
```
### Sending preview comments elsewhere
You can also use this action to generate the comment without actually commenting.
By disabling commenting with **comment** set to `false`, you can reuse this action with any workflow trigger and send it to any service accessible in GitHub Actions.
> See [Available variables](#available-variables) for a list of all outputs.
```yml
on:
push:
branches:
- main
jobs:
build:
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: 🏗 Setup Expo
uses: expo/expo-github-action@v7
with:
expo-version: latest
token: ${{ secrets.EXPO_TOKEN }}
- name: 📦 Install dependencies
run: yarn install
- name: 🚀 Publish preview
run: expo publish --release-channel=production --non-interactive
- name: 👷 Create preview comment
uses: expo/expo-github-action/preview-comment@v7
id: preview
with:
comment: false
channel: production
- name: 💬 Comment in Slack
uses: slackapi/[email protected]
env:
SLACK_BOT_TOKEN: ${{ secrets.SLACK_TOKEN }}
with:
channel-id: deployments
slack-message: 'New deployment is ready!\n- Preview: ${{ steps.preview.outputs.projectQR }}'
```
## Things to know
### Preventing duplicate comments
When automating these preview comments, you have to be careful not to spam a pull request on every successful run.
Every comment contains a generated **message-id** to identify previously made comments and update instead of creating a new comment.
### GitHub tokens
When using the GitHub API, you always need to be authenticated.
This action tries to auto-authenticate using the [Automatic token authentication][link-gha-token] from GitHub.
You can overwrite the token by adding the `GITHUB_TOKEN` environment variable, or add the **github-token** input.
<div align="center">
<br />
with :heart:&nbsp;<strong>byCedric</strong>
<br />
</div>
[code-defaults]: ../src/actions/preview-comment.ts
[link-actions]: https://help.github.com/en/categories/automating-your-workflow-with-github-actions
[link-gha-token]: https://docs.github.com/en/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token
+46
View File
@@ -0,0 +1,46 @@
---
name: Expo GitHub Action - Preview comment
author: Cedric van Putten <[email protected]>
description: Add Expo preview comments to pull requests
branding:
icon: message-circle
color: gray-dark
runs:
using: node16
main: ../build/preview-comment/index.js
inputs:
project:
description: Path to the Expo project, relative from the workspace
required: false
channel:
description: Release channel to preview
required: false
comment:
description: If the action should comment on a PR
required: false
default: true
message:
description: Pull request comment template
required: false
message-id:
description: A unique identifier to prevent multiple comments on the same pull request
required: false
github-token:
description: GitHub access token to comment on PRs
required: false
default: ${{ github.token }}
outputs:
projectOwner:
description: The resolved project owner
projectName:
description: The resolved project name
projectSlug:
description: The resolved project slug
projectQR:
description: The absolute URL to the QR code
projectLink:
description: The absolute link to the project on expo.dev
messageId:
description: The resolved message id
message:
description: The resolved message content
+72
View File
@@ -0,0 +1,72 @@
import { getBooleanInput, getInput, setOutput, info } from '@actions/core';
import { projectInfo, projectLink, projectOwner, projectQR } from '../expo';
import { createIssueComment, pullContext } from '../github';
import { executeAction } from '../worker';
export type CommentInput = ReturnType<typeof commentInput>;
export const DEFAULT_ID = `app:@{projectOwner}/{projectSlug} channel:{channel}`;
export const DEFAULT_MESSAGE =
`This pull request was automatically deployed using [Expo GitHub Actions](https://github.com/expo/expo-github-action/tree/main/preview-comment)!\n` +
`\n- Project: **@{projectOwner}/{projectSlug}**` +
`\n- Channel: **{channel}**` +
`\n\n<a href="{projectQR}"><img src="{projectQR}" height="200px" width="200px"></a>`;
export function commentInput() {
return {
channel: getInput('channel') || 'default',
comment: !getInput('comment') || getBooleanInput('comment'),
message: getInput('message') || DEFAULT_MESSAGE,
messageId: getInput('message-id') || DEFAULT_ID,
project: getInput('project'),
githubToken: getInput('github-token'),
};
}
executeAction(commentAction);
export async function commentAction(input: CommentInput = commentInput()) {
const project = await projectInfo(input.project);
if (!project.owner) {
project.owner = await projectOwner();
}
const variables: Record<string, string> = {
projectLink: projectLink(project, input.channel),
projectName: project.name,
projectOwner: project.owner || '',
projectQR: projectQR(project, input.channel),
projectSlug: project.slug,
channel: input.channel,
};
const messageId = template(input.messageId, variables);
const messageBody = template(input.message, variables);
if (!input.comment) {
info(`Skipped comment: 'comment' is disabled`);
} else {
await createIssueComment({
...pullContext(),
token: input.githubToken,
id: messageId,
body: messageBody,
});
}
for (const name in variables) {
setOutput(name, variables[name]);
}
setOutput('messageId', messageId);
setOutput('message', messageBody);
}
function template(template: string, replacements: Record<string, string>) {
let result = template;
for (const name in replacements) {
result = result.replaceAll(`{${name}}`, replacements[name]);
}
return result;
}
+14 -15
View File
@@ -1,11 +1,9 @@
import { getBooleanInput, getInput, group, info } from '@actions/core';
import { restoreFromCache, saveToCache } from '../cacher';
import { authenticate } from '../expo';
import { installPackage, resolvePackage } from '../packager';
import { executeAction, expoAuthenticate, findTool, installToolFromPackage, patchWatchers } from '../worker';
// Auto-execute in GitHub actions
executeAction(setupAction);
import { executeAction, findTool, installToolFromPackage, patchWatchers } from '../worker';
export type SetupInput = ReturnType<typeof setupInput>;
@@ -21,7 +19,9 @@ export function setupInput() {
};
}
export async function setupAction(input: SetupInput = setupInput()): Promise<void> {
executeAction(setupAction);
export async function setupAction(input: SetupInput = setupInput()) {
if (!input.expoVersion) {
info(`Skipped installing expo-cli: 'expo-version' not provided.`);
} else {
@@ -41,14 +41,14 @@ export async function setupAction(input: SetupInput = setupInput()): Promise<voi
? `Installing eas-cli (${version}) from cache or with ${input.packager}`
: `Installing eas-cli (${version}) with ${input.packager}`;
await group(message, () => installCli('eas-cli', input.easVersion, input.packager, input.easCache));
await group(message, () => installCli('eas-cli', version, input.packager, input.easCache));
}
if (!input.token) {
info(`Skipped authentication: 'token' not provided.`);
} else {
await group('Validating authenticated account', () =>
expoAuthenticate(input.token, input.easVersion ? 'eas' : input.expoVersion ? 'expo' : undefined)
authenticate(input.token, input.easVersion ? 'eas' : input.expoVersion ? 'expo' : undefined)
);
}
@@ -59,19 +59,18 @@ export async function setupAction(input: SetupInput = setupInput()): Promise<voi
}
}
async function installCli(name: string, version: string, packager: string, cache: boolean = true) {
const cliVersion = await resolvePackage(name, version);
let cliPath = findTool(name, cliVersion) || undefined;
async function installCli(name: string, version: string, packager: string, useCache = true) {
let cliPath = findTool(name, version) || undefined;
if (!cliPath && cache) {
cliPath = await restoreFromCache(name, cliVersion, packager);
if (!cliPath && useCache) {
cliPath = await restoreFromCache(name, version, packager);
}
if (!cliPath) {
cliPath = await installPackage(name, cliVersion, packager);
cliPath = await installPackage(name, version, packager);
if (cache) {
await saveToCache(name, cliVersion, packager);
if (useCache) {
await saveToCache(name, version, packager);
}
}
+100
View File
@@ -0,0 +1,100 @@
import { info, exportVariable } from '@actions/core';
import { exec, getExecOutput } from '@actions/exec';
import { which } from '@actions/io';
import { ok as assert } from 'assert';
import { URL } from 'url';
export type CliName = 'expo' | 'eas';
export interface ProjectInfo {
name: string;
slug: string;
owner?: string;
}
/**
* Try to authenticate the user using either Expo or EAS CLI.
* This method tries to invoke 'whoami' to validate if the token is valid.
* If that passes, the token is exported as EXPO_TOKEN for all steps within the job.
*/
export async function authenticate(token: string, cli: CliName = 'expo'): Promise<void> {
if (!cli) {
info(`Skipped token validation: no CLI installed, can't run 'whoami'.`);
} else {
await exec(await which(cli), ['whoami'], {
env: { ...process.env, EXPO_TOKEN: token },
});
}
exportVariable('EXPO_TOKEN', token);
}
/**
* Try to resolve the project owner, by running 'eas|expo whoami'.
*/
export async function projectOwner(cli: CliName = 'expo'): Promise<string> {
let stdout = '';
try {
({ stdout } = await getExecOutput(await which(cli), ['whoami'], { silent: true }));
} catch (error) {
throw new Error(`Could not fetch the project owner, reason:\n${error.message | error}`);
}
if (!stdout) {
throw new Error(`Could not fetch the project owner, not authenticated`);
} else if (stdout.endsWith(' (robot)')) {
throw new Error(`Could not fetch the project owner, used robot account`);
}
return stdout.trim();
}
/**
* Try to resolve the project info, by running 'expo config --type prebuild'.
*/
export async function projectInfo(dir: string): Promise<ProjectInfo> {
let stdout = '';
try {
({ stdout } = await getExecOutput(await which('expo', true), ['config', '--json', '--type', 'prebuild'], {
cwd: dir,
silent: true,
}));
} catch (error) {
throw new Error(`Could not fetch the project info from ${dir}, reason:\n${error.message || error}`);
}
const { name, slug, owner } = JSON.parse(stdout);
return { name, slug, owner };
}
/**
* Create a QR code for an update on project, with an optional release channel.
*/
export function projectQR(project: ProjectInfo, channel?: string): string {
assert(project.owner, 'Could not create a QR code for project without owner');
const url = new URL('https://qr.expo.dev/expo-go');
url.searchParams.append('owner', project.owner);
url.searchParams.append('slug', project.slug);
if (channel) {
url.searchParams.append('releaseChannel', channel);
}
return url.toString();
}
/**
* Create a link for the project in Expo.
*/
export function projectLink(project: ProjectInfo, channel?: string): string {
assert(project.owner, 'Could not create a QR code for project without owner');
const url = new URL(`https://expo.dev/@${project.owner}/${project.slug}`);
if (channel) {
url.searchParams.append('release-channel', channel);
}
return url.toString();
}
+92
View File
@@ -0,0 +1,92 @@
import { getOctokit, context } from '@actions/github';
import { ok as assert } from 'assert';
type IssueContext = typeof context['issue'];
type AuthContext = {
/** GitHub token from the 'github-input' to authenticate with */
token?: string;
};
type Comment = {
/** A hidden identifier to embed in the comment */
id: string;
/** The contents of the comment */
body: string;
};
/**
* Determine if a comment exists on an issue or pull with the provided identifier.
* This will iterate all comments received from GitHub, and try to exit early if it exists.
*/
export async function fetchIssueComment(options: AuthContext & IssueContext & Pick<Comment, 'id'>) {
const github = githubApi(options);
const iterator = github.paginate.iterator(github.rest.issues.listComments, {
owner: options.owner,
repo: options.repo,
issue_number: options.number,
});
for await (const { data: batch } of iterator) {
for (const item of batch) {
if ((item.body || '').includes(options.id)) {
return item;
}
}
}
}
/**
* Create a new comment on an existing issue or pull.
* This includes a hidden identifier (markdown comment) to identify the comment later.
* It will also update the comment when a previous comment id was found.
*/
export async function createIssueComment(options: AuthContext & IssueContext & Comment) {
const github = githubApi(options);
const body = `<!-- ${options.id} -->\n${options.body}`;
const existing = await fetchIssueComment(options);
if (existing) {
return github.rest.issues.updateComment({
owner: options.owner,
repo: options.repo,
comment_id: existing.id,
body,
});
}
return github.rest.issues.createComment({
owner: options.owner,
repo: options.repo,
issue_number: options.number,
body,
});
}
/**
* Get an authenticated octokit instance.
* This uses the 'GITHUB_TOKEN' environment variable, or 'github-token' input.
*/
export function githubApi(options: AuthContext = {}): ReturnType<typeof getOctokit> {
const token = process.env['GITHUB_TOKEN'] || options.token;
assert(token, `This step requires 'github-token' or a GITHUB_TOKEN environment variable to create comments`);
return getOctokit(token);
}
/**
* Validate and extract the pull reference from context.
* If it's not a supported event, e.g. not a pull, it will throw an error.
* Unfortunately, we can't overwrite the GitHub event details, it includes some testing code.
*/
export function pullContext(): IssueContext {
// see .github/workflows/test.yml in 'comment'
if (process.env['EXPO_TEST_GITHUB_PULL']) {
return { ...context.repo, number: Number(process.env['EXPO_TEST_GITHUB_PULL']) };
}
assert(
context.eventName === 'pull_request',
'Could not find the pull request context, make sure to run this from a pull_request triggered workflow'
);
return context.issue;
}
+7 -9
View File
@@ -1,4 +1,4 @@
import { exec } from '@actions/exec';
import { exec, getExecOutput } from '@actions/exec';
import { which, mkdirP } from '@actions/io';
import { cacheTool, tempPath } from './worker';
@@ -12,18 +12,16 @@ export async function resolvePackage(name: string, range: string): Promise<strin
let stdout = '';
try {
await exec('npm', ['info', `${name}@${range}`, 'version', '--json'], {
silent: true,
listeners: {
stdout(data) {
stdout += data.toString();
},
},
});
({ stdout } = await getExecOutput('npm', ['info', `${name}@${range}`, 'version', '--json'], { silent: true }));
} catch (error) {
throw new Error(`Could not resolve ${name}@${range}, reason:\n${error.message || error}`);
}
// thanks npm, for returning a "" json string value for invalid versions
if (!stdout) {
throw new Error(`Could not resolve ${name}@${range}, reason:\nInvalid version`);
}
// thanks npm, for returning a "x.x.x" json value...
if (stdout.startsWith('"')) {
stdout = `[${stdout}]`;
+23 -42
View File
@@ -1,28 +1,23 @@
import { addPath, exportVariable, info, setFailed, warning } from '@actions/core';
import { addPath, debug, info, setFailed, warning } from '@actions/core';
import { exec } from '@actions/exec';
import { which } from '@actions/io';
import { ok as assert } from 'assert';
import os from 'os';
import path from 'path';
export { find as findTool, cacheDir as cacheTool } from '@actions/tool-cache';
export function tempPath(name: string, version: string): string {
const temp = process.env['RUNNER_TEMP'] || '';
if (!temp) {
throw new Error(`Could not resolve temporary path, 'RUNNER_TEMP' not defined.`);
}
return path.join(temp, name, version, os.arch());
}
export function toolPath(name: string, version: string): string {
const toolCache = process.env['RUNNER_TOOL_CACHE'] || '';
if (!toolCache) {
throw new Error(`Could not resolve the local tool cache, 'RUNNER_TOOL_CACHE' not defined.`);
}
// https://github.com/actions/toolkit/blob/daf8bb00606d37ee2431d9b1596b88513dcf9c59/packages/tool-cache/src/tool-cache.ts#L747-L749
return path.join(toolCache, name, version, os.arch());
/**
* Auto-execute the action and pass errors to 'core.setFailed'.
* It also passes the full error, with stacktrace, to 'core.debug'.
* You'll need to enable debugging to view these full errors.
*
* @see https://github.com/actions/toolkit/blob/main/docs/action-debugging.md#step-debug-logs
*/
export function executeAction(action: () => Promise<void>) {
return action().catch((error: Error) => {
setFailed(error.message || error);
debug(error.stack || 'No stacktrace available');
});
}
/**
@@ -63,31 +58,17 @@ export async function patchWatchers(): Promise<void> {
}
}
/**
* Try to authenticate the user using either Expo or EAS CLI.
* This method tries to invoke 'whoami' to validate if the token is valid.
* If that passes, the token is exported as EXPO_TOKEN for all steps within the job.
*/
export async function expoAuthenticate(token: string, cli?: 'expo' | 'eas'): Promise<void> {
if (!cli) {
info(`Skipped token validation: no CLI installed, can't run 'whoami'.`);
} else {
await exec(await which(cli), ['whoami'], {
env: { ...process.env, EXPO_TOKEN: token },
});
}
exportVariable('EXPO_TOKEN', token);
export function tempPath(name: string, version: string): string {
assert(process.env['RUNNER_TEMP'], 'Could not resolve temporary path, RUNNER_TEMP not defined');
return path.join(process.env['RUNNER_TEMP'], name, version, os.arch());
}
/**
* Auto-execute the action if it's not running in a test environment.
* This also propagate possible errors to GitHub actions, with setFailed.
* Get the package path to the tool cache.
*
* @see https://github.com/actions/toolkit/blob/daf8bb00606d37ee2431d9b1596b88513dcf9c59/packages/tool-cache/src/tool-cache.ts#L747-L749
*/
export async function executeAction(action: () => Promise<void>) {
if (process.env.JEST_WORKER_ID) {
return Promise.resolve(null);
}
return action().catch(setFailed);
export function toolPath(name: string, version: string): string {
assert(process.env['RUNNER_TOOL_CACHE'], 'Could not resolve the local tool cache, RUNNER_TOOL_CACHE not defined');
return path.join(process.env['RUNNER_TOOL_CACHE'], name, version, os.arch());
}
+139
View File
@@ -0,0 +1,139 @@
import * as core from '@actions/core';
import {
CommentInput,
commentInput,
commentAction,
DEFAULT_ID,
DEFAULT_MESSAGE,
} from '../../src/actions/preview-comment';
import * as expo from '../../src/expo';
import * as github from '../../src/github';
import { mockInput } from '../utils';
jest.mock('@actions/core');
jest.mock('../../src/expo');
jest.mock('../../src/github');
jest.mock('../../src/worker');
describe(commentInput, () => {
it('returns object with correct defaults', () => {
expect(commentInput()).toMatchObject({
channel: 'default',
comment: true,
message: DEFAULT_MESSAGE,
messageId: DEFAULT_ID,
project: undefined,
githubToken: undefined,
});
});
it('returns project path', () => {
mockInput({ project: 'fake/project' });
expect(commentInput()).toMatchObject({ project: 'fake/project' });
});
it('returns disabled comment', () => {
mockInput({ comment: 'false' });
expect(commentInput()).toMatchObject({ comment: false });
});
it('returns message and id', () => {
mockInput({ message: 'fake message', 'message-id': 'fake id' });
expect(commentInput()).toMatchObject({ message: 'fake message', messageId: 'fake id' });
});
it('returns channel', () => {
mockInput({ channel: 'pr-420' });
expect(commentInput()).toMatchObject({ channel: 'pr-420' });
});
it('returns github-token', () => {
mockInput({ 'github-token': 'fakegithubtoken' });
expect(commentInput()).toMatchObject({ githubToken: 'fakegithubtoken' });
});
});
describe(commentAction, () => {
const input: CommentInput = {
channel: 'default',
comment: false,
message: DEFAULT_MESSAGE,
messageId: DEFAULT_ID,
project: '',
githubToken: '',
};
beforeEach(() => {
jest.mocked(expo.projectInfo).mockResolvedValue({ name: 'fakename', slug: 'fakeslug' });
jest.mocked(expo.projectOwner).mockResolvedValue('fakeuser');
});
it('resolves project info by project path', async () => {
await commentAction({ ...input, project: 'fake/path' });
expect(expo.projectInfo).toBeCalledWith('fake/path');
});
it('resolves project owner info by manifest owner', async () => {
jest.mocked(expo.projectInfo).mockResolvedValue({ name: 'fakename', slug: 'fakeslug', owner: 'fakeowner' });
await commentAction({ ...input });
expect(core.setOutput).toBeCalledWith('projectOwner', 'fakeowner');
expect(expo.projectOwner).not.toBeCalled();
});
it('resolves project owner info by current user', async () => {
await commentAction({ ...input });
expect(core.setOutput).toBeCalledWith('projectOwner', 'fakeuser');
});
it('creates comment when enabled', async () => {
await commentAction({ ...input, comment: true });
expect(github.pullContext).toBeCalled();
expect(github.createIssueComment).toBeCalled();
});
it('resolves the template variables for message', async () => {
await commentAction({ ...input });
const message = jest.mocked(core.setOutput).mock.calls.find(call => call[0] === 'message');
expect(message![1]).not.toMatch(DEFAULT_MESSAGE);
});
describe('outputs', () => {
it('sets projectOwner', async () => {
await commentAction({ ...input });
expect(core.setOutput).toBeCalledWith('projectOwner', 'fakeuser');
});
it('sets projectName', async () => {
await commentAction({ ...input });
expect(core.setOutput).toBeCalledWith('projectName', 'fakename');
});
it('sets projectSlug', async () => {
await commentAction({ ...input });
expect(core.setOutput).toBeCalledWith('projectSlug', 'fakeslug');
});
it('sets projectLink', async () => {
jest.mocked(expo.projectLink).mockReturnValue('https://expo.dev/@fakeuser/fakeslug');
await commentAction({ ...input });
expect(core.setOutput).toBeCalledWith('projectLink', 'https://expo.dev/@fakeuser/fakeslug');
});
it('sets projectQR', async () => {
jest.mocked(expo.projectQR).mockReturnValue('https://qr.expo.dev/expo-go?owner=fakeuser&slug=fakeslug');
await commentAction({ ...input });
expect(core.setOutput).toBeCalledWith('projectQR', 'https://qr.expo.dev/expo-go?owner=fakeuser&slug=fakeslug');
});
it('sets message', async () => {
await commentAction({ ...input });
expect(core.setOutput).toBeCalledWith('message', expect.any(String));
});
it('sets messageId', async () => {
await commentAction({ ...input });
expect(core.setOutput).toBeCalledWith('messageId', expect.any(String));
});
});
});
+5 -3
View File
@@ -2,12 +2,14 @@ import * as core from '@actions/core';
import { SetupInput, setupInput, setupAction } from '../../src/actions/setup';
import * as cacher from '../../src/cacher';
import * as expo from '../../src/expo';
import * as packager from '../../src/packager';
import * as worker from '../../src/worker';
import { mockInput } from '../utils';
jest.mock('@actions/core');
jest.mock('../../src/cacher');
jest.mock('../../src/expo');
jest.mock('../../src/packager');
jest.mock('../../src/worker');
@@ -88,17 +90,17 @@ describe(setupAction, () => {
it('authenticates token with eas-cli by default', async () => {
await setupAction({ ...input, expoVersion: 'latest', easVersion: 'latest', token: 'faketoken' });
expect(worker.expoAuthenticate).toBeCalledWith('faketoken', 'eas');
expect(expo.authenticate).toBeCalledWith('faketoken', 'eas');
});
it('authenticates token with expo-cli without eas-cli', async () => {
await setupAction({ ...input, expoVersion: 'latest', token: 'faketoken' });
expect(worker.expoAuthenticate).toBeCalledWith('faketoken', 'expo');
expect(expo.authenticate).toBeCalledWith('faketoken', 'expo');
});
it('authenticates token without any cli', async () => {
await setupAction({ ...input, token: 'faketoken' });
expect(worker.expoAuthenticate).toBeCalledWith('faketoken', undefined);
expect(expo.authenticate).toBeCalledWith('faketoken', undefined);
});
it('patches watchers', async () => {
+70
View File
@@ -0,0 +1,70 @@
import * as core from '@actions/core';
import * as exec from '@actions/exec';
import * as io from '@actions/io';
import { authenticate, projectQR, projectLink } from '../src/expo';
jest.mock('@actions/core');
jest.mock('@actions/exec');
jest.mock('@actions/io');
describe(authenticate, () => {
it('exports EXPO_TOKEN variable', async () => {
await authenticate('faketoken', undefined);
expect(core.exportVariable).toBeCalledWith('EXPO_TOKEN', 'faketoken');
});
it('validates EXPO_TOKEN with expo-cli', async () => {
jest.mocked(io.which).mockResolvedValue('expo');
await authenticate('faketoken', 'expo');
expect(io.which).toBeCalledWith('expo');
expect(exec.exec).toBeCalledWith('expo', ['whoami'], {
env: expect.objectContaining({ EXPO_TOKEN: 'faketoken' }),
});
});
it('validates EXPO_TOKEN with eas-cli', async () => {
jest.mocked(io.which).mockResolvedValue('eas');
await authenticate('faketoken', 'eas');
expect(io.which).toBeCalledWith('eas');
expect(exec.exec).toBeCalledWith('eas', ['whoami'], {
env: expect.objectContaining({ EXPO_TOKEN: 'faketoken' }),
});
});
});
describe(projectQR, () => {
it('throws when owner is undefined', () => {
expect(() => projectQR({ name: 'fakename', slug: 'fakeslug' })).toThrow('without owner');
});
it('returns url with owner and slug', () => {
expect(projectQR({ name: 'fakename', slug: 'fakeslug', owner: 'fakeowner' })).toBe(
'https://qr.expo.dev/expo-go?owner=fakeowner&slug=fakeslug'
);
});
it('returns url with owner, slug, and release channel', () => {
expect(projectQR({ name: 'fakename', slug: 'fakeslug', owner: 'fakeowner' }, 'fakechannel')).toBe(
'https://qr.expo.dev/expo-go?owner=fakeowner&slug=fakeslug&releaseChannel=fakechannel'
);
});
});
describe(projectLink, () => {
it('throws when owner is undefined', () => {
expect(() => projectLink({ name: 'fakename', slug: 'fakeslug' })).toThrow('without owner');
});
it('returns url with owner and slug', () => {
expect(projectLink({ name: 'fakename', slug: 'fakeslug', owner: 'fakeowner' })).toBe(
'https://expo.dev/@fakeowner/fakeslug'
);
});
it('returns url with owner, slug, and release channel', () => {
expect(projectLink({ name: 'fakename', slug: 'fakeslug', owner: 'fakeowner' }, 'fakechannel')).toBe(
'https://expo.dev/@fakeowner/fakeslug?release-channel=fakechannel'
);
});
});
+52
View File
@@ -0,0 +1,52 @@
import * as github from '@actions/github';
import { githubApi, pullContext } from '../src/github';
import { setEnv, resetEnv } from './utils';
jest.mock('@actions/github');
describe(githubApi, () => {
afterEach(resetEnv);
it('throws when GITHUB_TOKEN and input are undefined', () => {
setEnv('GITHUB_TOKEN', '');
expect(() => githubApi()).toThrow(`requires 'github-token' or a GITHUB_TOKEN`);
});
it('returns octokit instance with GITHUB_TOKEN', () => {
setEnv('GITHUB_TOKEN', 'fakegithubtoken');
const fakeGithub = {};
jest.mocked(github.getOctokit).mockReturnValue(fakeGithub as any);
expect(githubApi()).toBe(fakeGithub);
expect(github.getOctokit).toBeCalledWith('fakegithubtoken');
});
it('returns octokit instance with input', () => {
setEnv('GITHUB_TOKEN', '');
const fakeGithub = {};
jest.mocked(github.getOctokit).mockReturnValue(fakeGithub as any);
expect(githubApi({ token: 'fakegithubtoken' })).toBe(fakeGithub);
expect(github.getOctokit).toBeCalledWith('fakegithubtoken');
});
it('uses GITHUB_TOKEN before input', () => {
setEnv('GITHUB_TOKEN', 'fakegithubtoken');
const fakeGithub = {};
jest.mocked(github.getOctokit).mockReturnValue(fakeGithub as any);
expect(githubApi({ token: 'badfakegithubtoken' })).toBe(fakeGithub);
expect(github.getOctokit).toBeCalledWith('fakegithubtoken');
});
});
describe(pullContext, () => {
it('throws when github context event is not a pull request', () => {
jest.mocked(github.context).eventName = 'push';
expect(() => pullContext()).toThrow('Could not find the pull request context');
});
it('returns pull request context', () => {
jest.mocked(github.context).eventName = 'pull_request';
jest.mocked(github.context).issue = { owner: 'fakeowner', repo: 'fakerepo', number: 1337 };
expect(pullContext()).toMatchObject({ owner: 'fakeowner', repo: 'fakerepo', number: 1337 });
});
});
+4
View File
@@ -22,4 +22,8 @@ describe(resolvePackage, () => {
'Could not resolve'
);
});
it('rejects expo-cli@9999999 with proper error', async () => {
await expect(resolvePackage('expo-cli', '9999999')).rejects.toThrow('Could not resolve');
});
});
+20 -49
View File
@@ -1,29 +1,20 @@
import * as core from '@actions/core';
import * as exec from '@actions/exec';
import * as io from '@actions/io';
import os from 'os';
import path from 'path';
import {
tempPath,
toolPath,
installToolFromPackage,
patchWatchers,
expoAuthenticate,
executeAction,
} from '../src/worker';
import { tempPath, toolPath, installToolFromPackage, patchWatchers, executeAction } from '../src/worker';
import { resetEnv, setEnv, setPlatform, resetPlatform } from './utils';
jest.mock('@actions/core');
jest.mock('@actions/exec');
jest.mock('@actions/io');
describe(tempPath, () => {
afterEach(resetEnv);
it('throws when RUNNER_TEMP is undefined', () => {
setEnv('RUNNER_TEMP', '');
expect(tempPath).toThrow(`'RUNNER_TEMP' not defined`);
expect(tempPath).toThrow(`RUNNER_TEMP not defined`);
});
it('returns path with name, version, and arch type', () => {
@@ -37,7 +28,7 @@ describe(toolPath, () => {
it('throws when RUNNER_TOOL_CACHE is undefined', () => {
setEnv('RUNNER_TOOL_CACHE', '');
expect(toolPath).toThrow(`'RUNNER_TOOL_CACHE' not defined`);
expect(toolPath).toThrow(`RUNNER_TOOL_CACHE not defined`);
});
it('returns path with name, version, and arch type', () => {
@@ -88,52 +79,32 @@ describe(patchWatchers, () => {
});
});
describe(expoAuthenticate, () => {
it('exports EXPO_TOKEN variable', async () => {
await expoAuthenticate('faketoken', undefined);
expect(core.exportVariable).toBeCalledWith('EXPO_TOKEN', 'faketoken');
});
it('validates EXPO_TOKEN with expo-cli', async () => {
jest.mocked(io.which).mockResolvedValue('expo');
await expoAuthenticate('faketoken', 'expo');
expect(io.which).toBeCalledWith('expo');
expect(exec.exec).toBeCalledWith('expo', ['whoami'], {
env: expect.objectContaining({ EXPO_TOKEN: 'faketoken' }),
});
});
it('validates EXPO_TOKEN with eas-cli', async () => {
jest.mocked(io.which).mockResolvedValue('eas');
await expoAuthenticate('faketoken', 'eas');
expect(io.which).toBeCalledWith('eas');
expect(exec.exec).toBeCalledWith('eas', ['whoami'], {
env: expect.objectContaining({ EXPO_TOKEN: 'faketoken' }),
});
});
});
describe(executeAction, () => {
afterEach(resetEnv);
it('skips executing action in jest', async () => {
const action = jest.fn(() => Promise.resolve());
await executeAction(action);
expect(action).not.toBeCalled();
});
it('executes action outside jest', async () => {
setEnv('JEST_WORKER_ID', '');
it('executes action', async () => {
const action = jest.fn(() => Promise.resolve());
await executeAction(action);
expect(action).toBeCalled();
});
it('handles action errors', async () => {
setEnv('JEST_WORKER_ID', '');
const error = new Error('fake error');
const action = jest.fn(() => Promise.reject(error));
await expect(executeAction(action)).resolves.not.toThrow();
expect(core.setFailed).toBeCalledWith(error);
expect(core.setFailed).toBeCalledWith(error.message);
});
it('provides full stacktrace to debug', async () => {
const error = new Error('fake error');
const action = jest.fn(() => Promise.reject(error));
await expect(executeAction(action)).resolves.not.toThrow();
expect(core.debug).toBeCalledWith(error.stack);
});
it('provides fallback stacktrace to debug', async () => {
const error = new Error('fake error');
error.stack = undefined;
const action = jest.fn(() => Promise.reject(error));
await expect(executeAction(action)).resolves.not.toThrow();
expect(core.debug).toBeCalledWith('No stacktrace available');
});
});
+73 -4
View File
@@ -36,6 +36,16 @@
dependencies:
"@actions/io" "^1.0.1"
"@actions/github@^5.0.0":
version "5.0.0"
resolved "https://registry.yarnpkg.com/@actions/github/-/github-5.0.0.tgz#1754127976c50bd88b2e905f10d204d76d1472f8"
integrity sha512-QvE9eAAfEsS+yOOk0cylLBIO/d6WyWIOvsxxzdrPFaud39G6BOkUwScXZn1iBzQzHyu9SBkkLSWlohDWdsasAQ==
dependencies:
"@actions/http-client" "^1.0.11"
"@octokit/core" "^3.4.0"
"@octokit/plugin-paginate-rest" "^2.13.3"
"@octokit/plugin-rest-endpoint-methods" "^5.1.1"
"@actions/glob@^0.1.0":
version "0.1.2"
resolved "https://registry.yarnpkg.com/@actions/glob/-/glob-0.1.2.tgz#9685ed2d6583093479c8f137d067c4329d7d0974"
@@ -1069,7 +1079,7 @@
dependencies:
"@octokit/types" "^6.0.3"
"@octokit/core@^3.5.0":
"@octokit/core@^3.4.0", "@octokit/core@^3.5.0":
version "3.5.1"
resolved "https://registry.yarnpkg.com/@octokit/core/-/core-3.5.1.tgz#8601ceeb1ec0e1b1b8217b960a413ed8e947809b"
integrity sha512-omncwpLVxMP+GLpLPgeGJBF6IWJFjXDS5flY5VbppePYX9XehevbDykRH9PdCdvqt9TS5AOTiDide7h0qrkHjw==
@@ -1100,11 +1110,23 @@
"@octokit/types" "^6.0.3"
universal-user-agent "^6.0.0"
"@octokit/openapi-types@^11.2.0":
version "11.2.0"
resolved "https://registry.yarnpkg.com/@octokit/openapi-types/-/openapi-types-11.2.0.tgz#b38d7fc3736d52a1e96b230c1ccd4a58a2f400a6"
integrity sha512-PBsVO+15KSlGmiI8QAzaqvsNlZlrDlyAJYcrXBCvVUxCp7VnXjkwPoFHgjEJXx3WF9BAwkA6nfCUA7i9sODzKA==
"@octokit/openapi-types@^7.3.2":
version "7.3.2"
resolved "https://registry.yarnpkg.com/@octokit/openapi-types/-/openapi-types-7.3.2.tgz#065ce49b338043ec7f741316ce06afd4d459d944"
integrity sha512-oJhK/yhl9Gt430OrZOzAl2wJqR0No9445vmZ9Ey8GjUZUpwuu/vmEFP0TDhDXdpGDoxD6/EIFHJEcY8nHXpDTA==
"@octokit/plugin-paginate-rest@^2.13.3":
version "2.17.0"
resolved "https://registry.yarnpkg.com/@octokit/plugin-paginate-rest/-/plugin-paginate-rest-2.17.0.tgz#32e9c7cab2a374421d3d0de239102287d791bce7"
integrity sha512-tzMbrbnam2Mt4AhuyCHvpRkS0oZ5MvwwcQPYGtMv4tUa5kkzG58SVB0fcsLulOZQeRnOgdkZWkRUiyBlh0Bkyw==
dependencies:
"@octokit/types" "^6.34.0"
"@octokit/plugin-paginate-rest@^2.6.2":
version "2.13.5"
resolved "https://registry.yarnpkg.com/@octokit/plugin-paginate-rest/-/plugin-paginate-rest-2.13.5.tgz#e459f9b5dccbe0a53f039a355d5b80c0a2b0dc57"
@@ -1125,6 +1147,14 @@
"@octokit/types" "^6.16.2"
deprecation "^2.3.1"
"@octokit/plugin-rest-endpoint-methods@^5.1.1":
version "5.13.0"
resolved "https://registry.yarnpkg.com/@octokit/plugin-rest-endpoint-methods/-/plugin-rest-endpoint-methods-5.13.0.tgz#8c46109021a3412233f6f50d28786f8e552427ba"
integrity sha512-uJjMTkN1KaOIgNtUPMtIXDOjx6dGYysdIFhgA52x4xSadQCz3b/zJexvITDVpANnfKPW/+E0xkOvLntqMYpviA==
dependencies:
"@octokit/types" "^6.34.0"
deprecation "^2.3.1"
"@octokit/request-error@^2.0.5", "@octokit/request-error@^2.1.0":
version "2.1.0"
resolved "https://registry.yarnpkg.com/@octokit/request-error/-/request-error-2.1.0.tgz#9e150357831bfc788d13a4fd4b1913d60c74d677"
@@ -1163,6 +1193,13 @@
dependencies:
"@octokit/openapi-types" "^7.3.2"
"@octokit/types@^6.34.0":
version "6.34.0"
resolved "https://registry.yarnpkg.com/@octokit/types/-/types-6.34.0.tgz#c6021333334d1ecfb5d370a8798162ddf1ae8218"
integrity sha512-s1zLBjWhdEI2zwaoSgyOFoKSl109CUcVBCc7biPJ3aAf6LGLU6szDvi31JPU7bxfla2lqfhjbbg/5DdFNxOwHw==
dependencies:
"@octokit/openapi-types" "^11.2.0"
"@opencensus/[email protected]":
version "0.0.7"
resolved "https://registry.yarnpkg.com/@opencensus/web-types/-/web-types-0.0.7.tgz#4426de1fe5aa8f624db395d2152b902874f0570a"
@@ -1206,6 +1243,18 @@
resolved "https://registry.yarnpkg.com/@semantic-release/error/-/error-3.0.0.tgz#30a3b97bbb5844d695eb22f9d3aa40f6a92770c2"
integrity sha512-5hiM4Un+tpl4cKw3lV4UgzJj+SmfNIDCLLw0TepzQxz9ZGV5ixnqkzIVF+3tp0ZHgcMKE+VNGHJjEeyFG2dcSw==
"@semantic-release/exec@^6.0.3":
version "6.0.3"
resolved "https://registry.yarnpkg.com/@semantic-release/exec/-/exec-6.0.3.tgz#d212fdf19633bdfb553de6cb6c7f8781933224db"
integrity sha512-bxAq8vLOw76aV89vxxICecEa8jfaWwYITw6X74zzlO0mc/Bgieqx9kBRz9z96pHectiTAtsCwsQcUyLYWnp3VQ==
dependencies:
"@semantic-release/error" "^3.0.0"
aggregate-error "^3.0.0"
debug "^4.0.0"
execa "^5.0.0"
lodash "^4.17.4"
parse-json "^5.0.0"
"@semantic-release/git@^10.0.1":
version "10.0.1"
resolved "https://registry.yarnpkg.com/@semantic-release/git/-/git-10.0.1.tgz#c646e55d67fae623875bf3a06a634dd434904498"
@@ -5035,9 +5084,11 @@ node-emoji@^1.10.0:
lodash.toarray "^4.4.0"
node-fetch@^2.6.0, node-fetch@^2.6.1:
version "2.6.1"
resolved "https://registry.yarnpkg.com/node-fetch/-/node-fetch-2.6.1.tgz#045bd323631f76ed2e2b55573394416b639a0052"
integrity sha512-V4aYg89jEoVRxRb2fJdAg8FHvI7cEyYdVAh94HH0UIK8oJxUfkjlDQN9RbMx+bEjP7+ggMiFRprSti032Oipxw==
version "2.6.7"
resolved "https://registry.yarnpkg.com/node-fetch/-/node-fetch-2.6.7.tgz#24de9fba827e3b4ae44dc8b20256a379160052ad"
integrity sha512-ZjMPFEfVx5j+y2yF35Kzx5sF7kDzxuDj6ziH4FFbOp87zKDZNx8yExJIb05OGF4Nlt9IHFIMBkRl41VdvcNdbQ==
dependencies:
whatwg-url "^5.0.0"
node-gyp@^7.1.0, node-gyp@^7.1.2:
version "7.1.2"
@@ -6593,6 +6644,11 @@ tr46@^2.1.0:
dependencies:
punycode "^2.1.1"
tr46@~0.0.3:
version "0.0.3"
resolved "https://registry.yarnpkg.com/tr46/-/tr46-0.0.3.tgz#8184fd347dac9cdc185992f3a6622e14b9d9ab6a"
integrity sha1-gYT9NH2snNwYWZLzpmIuFLnZq2o=
traverse@~0.6.6:
version "0.6.6"
resolved "https://registry.yarnpkg.com/traverse/-/traverse-0.6.6.tgz#cbdf560fd7b9af632502fed40f918c157ea97137"
@@ -6876,6 +6932,11 @@ wcwidth@^1.0.0:
dependencies:
defaults "^1.0.3"
webidl-conversions@^3.0.0:
version "3.0.1"
resolved "https://registry.yarnpkg.com/webidl-conversions/-/webidl-conversions-3.0.1.tgz#24534275e2a7bc6be7bc86611cc16ae0a5654871"
integrity sha1-JFNCdeKnvGvnvIZhHMFq4KVlSHE=
webidl-conversions@^5.0.0:
version "5.0.0"
resolved "https://registry.yarnpkg.com/webidl-conversions/-/webidl-conversions-5.0.0.tgz#ae59c8a00b121543a2acc65c0434f57b0fc11aff"
@@ -6898,6 +6959,14 @@ whatwg-mimetype@^2.3.0:
resolved "https://registry.yarnpkg.com/whatwg-mimetype/-/whatwg-mimetype-2.3.0.tgz#3d4b1e0312d2079879f826aff18dbeeca5960fbf"
integrity sha512-M4yMwr6mAnQz76TbJm914+gPpB/nCwvZbJU28cUD6dR004SAxDLOOSUaB1JDRqLtaOV/vi0IC5lEAGFgrjGv/g==
whatwg-url@^5.0.0:
version "5.0.0"
resolved "https://registry.yarnpkg.com/whatwg-url/-/whatwg-url-5.0.0.tgz#966454e8765462e37644d3626f6742ce8b70965d"
integrity sha1-lmRU6HZUYuN2RNNib2dCzotwll0=
dependencies:
tr46 "~0.0.3"
webidl-conversions "^3.0.0"
whatwg-url@^8.0.0, whatwg-url@^8.5.0:
version "8.6.0"
resolved "https://registry.yarnpkg.com/whatwg-url/-/whatwg-url-8.6.0.tgz#27c0205a4902084b872aecb97cf0f2a7a3011f4c"