feat: create github deployment

.github/workflows/example-scope.yml

@@ -8,7 +8,7 @@ on:
  - master
 
 jobs:
- static:
+ example-scope:
  runs-on: ubuntu-latest
  steps:
  - uses: actions/checkout@v2

.github/workflows/example-static.yml

@@ -3,7 +3,6 @@ on:
  push:
  branches:
  - master
- - feature/*
  pull_request:
  branches:
  - master
@@ -25,6 +24,8 @@ jobs:
  alias-domains: |
  staging.static.vercel-action.amond.dev
  pr-{{PR_NUMBER}}.static.vercel-action.amond.dev
+ github-deployment: true
+ github-deployment-environment: static-staging
  - name: production or not
  id: prod_or_not
  run: |
@@ -48,3 +49,5 @@ jobs:
  working-directory: example/static
  alias-domains: |
  {{BRANCH}}.static.vercel-action.amond.dev
+ github-deployment: true
+ github-deployment-environment: static-production

action.yml

@@ -19,6 +19,10 @@ inputs:
  required: false
  default: 'false'
  description: 'if you want to create github deployment, set true, default: false'
+ github-deployment-environment:
+ required: false
+ description: 'The environment parameter allows deployments to be issued to different runtime environments. Teams often have multiple environments for verifying their applications, such as production, staging, and qa. This parameter makes it easier to track which environments have requested deployments. The default environment is production.'
+ default: 'production'
  working-directory:
  required: false
  description: the working directory
@@ -55,7 +59,6 @@ inputs:
  required: false
  description: 'You can assign a domain to this deployment. Please note that this domain must have been configured in the project. You can use pull request number via `{{PR_NUMBER}}` and branch via `{{BRANCH}}`'
  default: ''
-
 outputs:
  preview-url:
  description: 'deployment preview URL'

dist/index.js

@@ -1149,6 +1149,9 @@ const aliasDomains = core
  return url;
  });
 
+const githubDeployment = core.getInput('github-deployment') === 'true';
+const githubDeploymentEnv = core.getInput('github-deployment-environment');
+
 let octokit;
 if (githubToken) {
  octokit = new github.GitHub(githubToken);
@@ -1399,17 +1402,54 @@ async function aliasDomainsToDeployment(deploymentUrl) {
  await Promise.all(promises);
 }
 
+function getEffectiveRef() {
+ let { ref } = context;
+ if (github.context.eventName === 'pull_request') {
+ const pullRequestPayload = github.context.payload;
+ ref = pullRequestPayload.pull_request.head.ref;
+ }
+ return ref;
+}
+
+async function createGithubDeployment() {
+ if (githubDeployment && octokit) {
+ core.debug(`Create a github deployment.`);
+ const { data: deployment } = await octokit.repos.createDeployment({
+ ...context.repo,
+ ref: getEffectiveRef(),
+ environment: githubDeploymentEnv,
+ required_contexts: [],
+ });
+ core.debug(`Created deployment is ${deployment.id}`);
+ return deployment.id;
+ }
+ return null;
+}
+
+async function createGithubDeploymentStatus(deploymentId, status, logUrl) {
+ if (githubDeployment && deploymentId && status && octokit) {
+ await octokit.repos.createDeploymentStatus({
+ ...context.repo,
+ deployment_id: deploymentId,
+ state: status,
+ log_url: logUrl,
+ });
+ }
+}
+
 async function run() {
  core.debug(`action : ${context.action}`);
  core.debug(`ref : ${context.ref}`);
  core.debug(`eventName : ${context.eventName}`);
  core.debug(`actor : ${context.actor}`);
  core.debug(`sha : ${context.sha}`);
  core.debug(`workflow : ${context.workflow}`);
- let { ref } = context;
+ let ref = getEffectiveRef();
  let { sha } = context;
  await setEnv();
 
+ const githubDeploymentId = await createGithubDeployment();
+
  let commit = execSync('git log -1 --pretty=format:%B')
  .toString()
  .trim();
@@ -1434,9 +1474,14 @@ async function run() {
  core.debug(`The head commit is: ${commit}`);
  }
  }
-
  const deploymentUrl = await vercelDeploy(ref, commit);
-
+ if (githubDeploymentId) {
+ await createGithubDeploymentStatus(
+ githubDeploymentId,
+ 'success',
+ deploymentUrl,
+ );
+ }
  if (deploymentUrl) {
  core.info('set preview-url output');
  if (aliasDomains && aliasDomains.length) {

index.js

@@ -52,6 +52,9 @@ const aliasDomains = core
  return url;
  });
 
+const githubDeployment = core.getInput('github-deployment') === 'true';
+const githubDeploymentEnv = core.getInput('github-deployment-environment');
+
 let octokit;
 if (githubToken) {
  octokit = new github.GitHub(githubToken);
@@ -302,17 +305,54 @@ async function aliasDomainsToDeployment(deploymentUrl) {
  await Promise.all(promises);
 }
 
+function getEffectiveRef() {
+ let { ref } = context;
+ if (github.context.eventName === 'pull_request') {
+ const pullRequestPayload = github.context.payload;
+ ref = pullRequestPayload.pull_request.head.ref;
+ }
+ return ref;
+}
+
+async function createGithubDeployment() {
+ if (githubDeployment && octokit) {
+ core.debug(`Create a github deployment.`);
+ const { data: deployment } = await octokit.repos.createDeployment({
+ ...context.repo,
+ ref: getEffectiveRef(),
+ environment: githubDeploymentEnv,
+ required_contexts: [],
+ });
+ core.debug(`Created deployment is ${deployment.id}`);
+ return deployment.id;
+ }
+ return null;
+}
+
+async function createGithubDeploymentStatus(deploymentId, status, logUrl) {
+ if (githubDeployment && deploymentId && status && octokit) {
+ await octokit.repos.createDeploymentStatus({
+ ...context.repo,
+ deployment_id: deploymentId,
+ state: status,
+ log_url: logUrl,
+ });
+ }
+}
+
 async function run() {
  core.debug(`action : ${context.action}`);
  core.debug(`ref : ${context.ref}`);
  core.debug(`eventName : ${context.eventName}`);
  core.debug(`actor : ${context.actor}`);
  core.debug(`sha : ${context.sha}`);
  core.debug(`workflow : ${context.workflow}`);
- let { ref } = context;
+ let ref = getEffectiveRef();
  let { sha } = context;
  await setEnv();
 
+ const githubDeploymentId = await createGithubDeployment();
+
  let commit = execSync('git log -1 --pretty=format:%B')
  .toString()
  .trim();
@@ -337,9 +377,14 @@ async function run() {
  core.debug(`The head commit is: ${commit}`);
  }
  }
-
  const deploymentUrl = await vercelDeploy(ref, commit);
-
+ if (githubDeploymentId) {
+ await createGithubDeploymentStatus(
+ githubDeploymentId,
+ 'success',
+ deploymentUrl,
+ );
+ }
  if (deploymentUrl) {
  core.info('set preview-url output');
  if (aliasDomains && aliasDomains.length) {