feature: add projectDeepLink to template variables (#165)

* feat: added projectDeepLink to template variables

* fix: updates from code review
This commit is contained in:
Giau. Tran Minh authored and GitHub committed 2022-03-03 15:25:52 -08:00
1 parent 520d9594e0
commit 2603f858e9
6 files changed
+73 -14

No files matched your search

+14 -1
View File
@@ -15785,6 +15785,7 @@ async function commentAction(input = commentInput()) {
}
const variables = {
projectLink: (0, expo_1.projectLink)(project, input.channel),
projectDeepLink: (0, expo_1.projectDeepLink)(project, input.channel),
projectName: project.name,
projectOwner: project.owner || '',
projectQR: (0, expo_1.projectQR)(project, input.channel),
@@ -15828,7 +15829,7 @@ function template(template, replacements) {
"use strict";
Object.defineProperty(exports, "__esModule", ({ value: true }));
exports.projectLink = exports.projectQR = exports.projectInfo = exports.projectOwner = exports.authenticate = void 0;
exports.projectDeepLink = exports.projectLink = exports.projectQR = exports.projectInfo = exports.projectOwner = exports.authenticate = void 0;
const core_1 = __nccwpck_require__(2186);
const exec_1 = __nccwpck_require__(1514);
const io_1 = __nccwpck_require__(7436);
@@ -15915,6 +15916,18 @@ function projectLink(project, channel) {
return url.toString();
}
exports.projectLink = projectLink;
/**
* Create a deep link to open the project in Expo Go
*/
function projectDeepLink(project, channel) {
(0, assert_1.ok)(project.owner, 'Could not create a deep link for project without owner');
const url = new url_1.URL(`exp://exp.host/@${project.owner}/${project.slug}`);
if (channel) {
url.searchParams.append('release-channel', channel);
}
return url.toString();
}
exports.projectDeepLink = projectDeepLink;
/***/ }),
+13 -1
View File
@@ -66905,7 +66905,7 @@ exports.handleCacheError = handleCacheError;
"use strict";
Object.defineProperty(exports, "__esModule", ({ value: true }));
exports.projectLink = exports.projectQR = exports.projectInfo = exports.projectOwner = exports.authenticate = void 0;
exports.projectDeepLink = exports.projectLink = exports.projectQR = exports.projectInfo = exports.projectOwner = exports.authenticate = void 0;
const core_1 = __nccwpck_require__(2186);
const exec_1 = __nccwpck_require__(1514);
const io_1 = __nccwpck_require__(7436);
@@ -66992,6 +66992,18 @@ function projectLink(project, channel) {
return url.toString();
}
exports.projectLink = projectLink;
/**
* Create a deep link to open the project in Expo Go
*/
function projectDeepLink(project, channel) {
(0, assert_1.ok)(project.owner, 'Could not create a deep link for project without owner');
const url = new url_1.URL(`exp://exp.host/@${project.owner}/${project.slug}`);
if (channel) {
url.searchParams.append('release-channel', channel);
}
return url.toString();
}
exports.projectDeepLink = projectDeepLink;
/***/ }),
+11 -10
View File
@@ -52,16 +52,17 @@ 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 |
| 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 |
| **projectDeepLink** | `{projectDeepLink}` | A deep link to open the project in Expo Go |
| **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
+2 -1
View File
@@ -1,6 +1,6 @@
import { getBooleanInput, getInput, setOutput, info } from '@actions/core';
import { projectInfo, projectLink, projectOwner, projectQR } from '../expo';
import { projectDeepLink, projectInfo, projectLink, projectOwner, projectQR } from '../expo';
import { createIssueComment, pullContext } from '../github';
import { executeAction } from '../worker';
@@ -34,6 +34,7 @@ export async function commentAction(input: CommentInput = commentInput()) {
const variables: Record<string, string> = {
projectLink: projectLink(project, input.channel),
projectDeepLink: projectDeepLink(project, input.channel),
projectName: project.name,
projectOwner: project.owner || '',
projectQR: projectQR(project, input.channel),
+14
View File
@@ -98,3 +98,17 @@ export function projectLink(project: ProjectInfo, channel?: string): string {
return url.toString();
}
/**
* Create a deep link to open the project in Expo Go
*/
export function projectDeepLink(project: ProjectInfo, channel?: string): string {
assert(project.owner, 'Could not create a deep link for project without owner');
const url = new URL(`exp://exp.host/@${project.owner}/${project.slug}`);
if (channel) {
url.searchParams.append('release-channel', channel);
}
return url.toString();
}
+19 -1
View File
@@ -2,7 +2,7 @@ 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';
import { authenticate, projectQR, projectLink, projectDeepLink } from '../src/expo';
jest.mock('@actions/core');
jest.mock('@actions/exec');
@@ -68,3 +68,21 @@ describe(projectLink, () => {
);
});
});
describe(projectDeepLink, () => {
it('throws when owner is undefined', () => {
expect(() => projectDeepLink({ name: 'fakename', slug: 'fakeslug' })).toThrow('without owner');
});
it('returns url with owner and slug', () => {
expect(projectDeepLink({ name: 'fakename', slug: 'fakeslug', owner: 'fakeowner' })).toBe(
'exp://exp.host/@fakeowner/fakeslug'
);
});
it('returns url with owner, slug, and release channel', () => {
expect(projectDeepLink({ name: 'fakename', slug: 'fakeslug', owner: 'fakeowner' }, 'fakechannel')).toBe(
'exp://exp.host/@fakeowner/fakeslug?release-channel=fakechannel'
);
});
});