adk23333/github-pages-deploy-action
1
0
Fork 0
mirror of https://github.com/JamesIves/github-pages-deploy-action.git synced 2023-12-15 20:03:39 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'dev' into releases/v4

Browse Source
This commit is contained in:
James Ives 2022-01-31 08:12:24 -05:00
commit 0752a8c57b
15 changed files with 182 additions and 123 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
.devcontainer/devcontainer.json
View File

@ -1,17 +1,15 @@
// https://github.com/microsoft/vscode-dev-containers/tree/master/containers/typescript-node // https://github.com/microsoft/vscode-dev-containers/tree/master/containers/typescript-node
{ {
"name": "Node.js & TypeScript", "name": "Node.js & TypeScript",
"build": { "build": {
"dockerfile": "Dockerfile", "dockerfile": "Dockerfile",
"args": { "args": {
"VARIANT": "14" "VARIANT": "14"
} }
}, },
"settings": { "settings": {
"terminal.integrated.shell.linux": "/bin/bash" "terminal.integrated.shell.linux": "/bin/bash"
}, },
"extensions": [ "extensions": ["dbaeumer.vscode-eslint"],
"dbaeumer.vscode-eslint" "remoteUser": "node"
],
"remoteUser": "node"
} }

6
.github/workflows/build.yml vendored
View File

@ -26,7 +26,7 @@ jobs:
- name: Install and Test - name: Install and Test
run: | run: |
yarn install yarn install --frozen-lockfile
yarn lint yarn lint
yarn test yarn test
@ -51,12 +51,12 @@ jobs:
- name: Build lib - name: Build lib
run: | run: |
yarn install yarn install --frozen-lockfile
yarn build yarn build
- name: Rebuild production node_modules - name: Rebuild production node_modules
run: | run: |
yarn install --production yarn install --production --frozen-lockfile
ls node_modules ls node_modules
- name: artifact - name: artifact

2
.github/workflows/deploy.yml vendored
View File

@ -13,7 +13,7 @@ jobs:
# Workflow dispatch event that pushes the current version to the release branch. # Workflow dispatch event that pushes the current version to the release branch.
# From here the secondary production deployment workflow will trigger to build the dependencies. # From here the secondary production deployment workflow will trigger to build the dependencies.
- name: Deploy 🚀 - name: Deploy 🚀
uses: JamesIves/github-pages-deploy-action@4.2.1 uses: JamesIves/github-pages-deploy-action@v4.2.2
with: with:
branch: releases/v4 branch: releases/v4
folder: . folder: .

24
.github/workflows/integration.yml vendored
View File

@ -23,7 +23,7 @@ jobs:
uses: actions/checkout@v2.4.0 uses: actions/checkout@v2.4.0
- name: Build and Deploy - name: Build and Deploy
uses: JamesIves/github-pages-deploy-action@4.2.1 uses: JamesIves/github-pages-deploy-action@v4
with: with:
git-config-name: Montezuma git-config-name: Montezuma
git-config-email: montezuma@jamesiv.es git-config-email: montezuma@jamesiv.es
@ -44,7 +44,7 @@ jobs:
uses: actions/checkout@v1 uses: actions/checkout@v1
- name: Build and Deploy - name: Build and Deploy
uses: JamesIves/github-pages-deploy-action@4.2.1 uses: JamesIves/github-pages-deploy-action@v4
with: with:
token: ${{ secrets.ACCESS_TOKEN }} token: ${{ secrets.ACCESS_TOKEN }}
branch: gh-pages branch: gh-pages
@ -71,7 +71,7 @@ jobs:
persist-credentials: false persist-credentials: false
- name: Build and Deploy - name: Build and Deploy
uses: JamesIves/github-pages-deploy-action@4.2.1 uses: JamesIves/github-pages-deploy-action@v4
with: with:
branch: gh-pages branch: gh-pages
folder: integration folder: integration
@ -103,7 +103,7 @@ jobs:
apt-get update && apt-get install -y rsync apt-get update && apt-get install -y rsync
- name: Build and Deploy - name: Build and Deploy
uses: JamesIves/github-pages-deploy-action@4.2.1 uses: JamesIves/github-pages-deploy-action@v4
with: with:
branch: gh-pages branch: gh-pages
folder: integration folder: integration
@ -127,7 +127,7 @@ jobs:
persist-credentials: false persist-credentials: false
- name: Build and Deploy - name: Build and Deploy
uses: JamesIves/github-pages-deploy-action@4.2.1 uses: JamesIves/github-pages-deploy-action@v4
with: with:
ssh-key: ${{ secrets.DEPLOY_KEY }} ssh-key: ${{ secrets.DEPLOY_KEY }}
branch: gh-pages branch: gh-pages
@ -157,7 +157,7 @@ jobs:
ssh-private-key: ${{ secrets.DEPLOY_KEY }} ssh-private-key: ${{ secrets.DEPLOY_KEY }}
- name: Build and Deploy - name: Build and Deploy
uses: JamesIves/github-pages-deploy-action@4.2.1 uses: JamesIves/github-pages-deploy-action@v4
with: with:
ssh-key: true ssh-key: true
branch: gh-pages branch: gh-pages
@ -186,7 +186,7 @@ jobs:
persist-credentials: false persist-credentials: false
- name: Build and Deploy - name: Build and Deploy
uses: JamesIves/github-pages-deploy-action@4.2.1 uses: JamesIves/github-pages-deploy-action@v4
with: with:
ssh-key: ${{ secrets.DEPLOY_KEY }} ssh-key: ${{ secrets.DEPLOY_KEY }}
branch: gh-pages branch: gh-pages
@ -195,7 +195,7 @@ jobs:
silent: true silent: true
- name: Build and Deploy - name: Build and Deploy
uses: JamesIves/github-pages-deploy-action@4.2.1 uses: JamesIves/github-pages-deploy-action@v4
with: with:
ssh-key: ${{ secrets.DEPLOY_KEY }} ssh-key: ${{ secrets.DEPLOY_KEY }}
branch: gh-pages branch: gh-pages
@ -218,7 +218,7 @@ jobs:
integration-container, integration-container,
integration-ssh, integration-ssh,
integration-ssh-third-party-client, integration-ssh-third-party-client,
integration-env, integration-env
] ]
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
@ -228,7 +228,7 @@ jobs:
persist-credentials: false persist-credentials: false
- name: Build and Deploy - name: Build and Deploy
uses: JamesIves/github-pages-deploy-action@4.2.1 uses: JamesIves/github-pages-deploy-action@v4
with: with:
token: ${{ secrets.ACCESS_TOKEN }} token: ${{ secrets.ACCESS_TOKEN }}
branch: gh-pages branch: gh-pages
@ -247,7 +247,7 @@ jobs:
persist-credentials: false persist-credentials: false
- name: Build and Deploy - name: Build and Deploy
uses: JamesIves/github-pages-deploy-action@4.2.1 uses: JamesIves/github-pages-deploy-action@v4
with: with:
token: ${{ secrets.ACCESS_TOKEN }} token: ${{ secrets.ACCESS_TOKEN }}
branch: integration-test-delete-prod branch: integration-test-delete-prod
@ -256,7 +256,7 @@ jobs:
silent: true silent: true
- name: Build and Deploy - name: Build and Deploy
uses: JamesIves/github-pages-deploy-action@4.2.1 uses: JamesIves/github-pages-deploy-action@v4
with: with:
token: ${{ secrets.ACCESS_TOKEN }} token: ${{ secrets.ACCESS_TOKEN }}
branch: integration-test-delete-prod branch: integration-test-delete-prod

4
.github/workflows/production.yml vendored
View File

@ -32,12 +32,12 @@ jobs:
- name: Build - name: Build
run: | run: |
yarn install yarn install --frozen-lockfile
yarn build yarn build
- name: Install Production node_modules - name: Install Production node_modules
run: | run: |
yarn install --production yarn install --production --frozen-lockfile
- name: Commit and Push - name: Commit and Push
# Keep the run green if the commit fails for the lack of changes # Keep the run green if the commit fails for the lack of changes

17
.github/workflows/sponsors.yml vendored
View File

@ -12,15 +12,24 @@ jobs:
uses: actions/checkout@v2.4.0 uses: actions/checkout@v2.4.0
- name: Generate Sponsors 💖 - name: Generate Sponsors 💖
uses: JamesIves/github-sponsors-readme-action@1.0.7 uses: JamesIves/github-sponsors-readme-action@v1.0.8
with: with:
token: ${{ secrets.PAT }} token: ${{ secrets.PAT }}
file: 'README.md' file: 'README.md'
template: '<a href="https://github.com/{{{ login }}}"><img src="https://github.com/{{{ login }}}.png" width="50px" alt="" /></a>' template: '<a href="https://github.com/{{{ login }}}"><img src="https://github.com/{{{ login }}}.png" width="50px" alt="{{{ login }}}" /></a>&nbsp;&nbsp;'
minimum: 500 maximum: 9999
- name: Generate Sponsors 💖
uses: JamesIves/github-sponsors-readme-action@v1.0.8
with:
token: ${{ secrets.PAT }}
file: 'README.md'
minimum: 10000
template: '<a href="https://github.com/{{{ login }}}"><img src="https://github.com/{{{ login }}}.png" width="80px" alt="{{{ login }}}" /></a>&nbsp;&nbsp;'
marker: 'premium'
- name: Deploy to GitHub Pages - name: Deploy to GitHub Pages
uses: JamesIves/github-pages-deploy-action@4.2.1 uses: JamesIves/github-pages-deploy-action@v4.2.2
with: with:
branch: dev branch: dev
folder: '.' folder: '.'

4
.github/workflows/version.yml vendored
View File

@ -3,11 +3,11 @@ name: Update Major Version Tag
on: on:
push: push:
tags: tags:
- "v*" - 'v*'
jobs: jobs:
update-majorver: update-majorver:
name: Update Major Version Tag name: Update Major Version Tag
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: nowactions/update-majorver@v1 - uses: nowactions/update-majorver@v1.1.2

40
README.md
View File

@ -1,6 +1,6 @@
<p align="center"> <p align="center">
<a href="https://github.com/marketplace/actions/deploy-to-github-pages"> <a href="https://github.com/marketplace/actions/deploy-to-github-pages">
<img alt="" width="200px" src="https://github.com/JamesIves/github-pages-deploy-action/raw/dev/.github/assets/icon.png"> <img alt="GitHub Pages Deploy Action Logo" width="200px" src="https://github.com/JamesIves/github-pages-deploy-action/raw/dev/.github/assets/icon.png">
</a> </a>
</p> </p>
@ -35,12 +35,24 @@
</p> </p>
<p align="center"> <p align="center">
<img src="https://github.com/JamesIves/github-pages-deploy-action/raw/dev/.github/assets/screenshot.png"> <img src="https://github.com/JamesIves/github-pages-deploy-action/raw/dev/.github/assets/screenshot.png" alt="">
</p>
<p align="center">
Maintainence of this project is made possible by all the <a href="https://github.com/JamesIves/github-pages-deploy-action/graphs/contributors">contributors</a> and <a href="https://github.com/sponsors/JamesIves">sponsors</a>. If you'd like to sponsor this project and have your avatar or company logo appear below <a href="https://github.com/sponsors/JamesIves">click here</a>. 💖
</p>
<p align="center">
<!-- premium --><!-- premium -->
</p>
<p align="center">
<!-- sponsors --><a href="https://github.com/Chooksta69"><img src="https://github.com/Chooksta69.png" width="50px" alt="Chooksta69" /></a>&nbsp;&nbsp;<a href="https://github.com/milanpollock"><img src="https://github.com/milanpollock.png" width="50px" alt="milanpollock" /></a>&nbsp;&nbsp;<a href="https://github.com/robjtede"><img src="https://github.com/robjtede.png" width="50px" alt="robjtede" /></a>&nbsp;&nbsp;<!-- sponsors -->
</p> </p>
## Getting Started :airplane: ## Getting Started :airplane:
You can include the action in your workflow to trigger on any event that [GitHub actions supports](https://help.github.com/en/articles/events-that-trigger-workflows). If the remote branch that you wish to deploy to doesn't already exist the action will create it for you. Your workflow will also need to include the `actions/checkout` step before this workflow runs in order for the deployment to work. You can include the action in your workflow to trigger on any event that [GitHub actions supports](https://help.github.com/en/articles/events-that-trigger-workflows). If the remote branch that you wish to deploy to doesn't already exist the action will create it for you. Your workflow will also need to include the `actions/checkout` step before this workflow runs in order for the deployment to work. If you intend to make multiple deployments in quick succession [you may need to levereage the concurrency parameter in your workflow](https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#concurrency) to prevent overlaps.
You can view an example of this below. You can view an example of this below.
@ -49,10 +61,11 @@ name: Build and Deploy
on: [push] on: [push]
jobs: jobs:
build-and-deploy: build-and-deploy:
concurrency: ci-${{ github.ref }} # Recommended if you intend to make multiple deployments in quick succession.
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout 🛎️ - name: Checkout 🛎️
uses: actions/checkout@v2.5.1 uses: actions/checkout@v2
- name: Install and Build 🔧 # This example project is built using npm and outputs the result to the 'build' folder. Replace with the commands required to build your project, or remove this step entirely if your site is pre-built. - name: Install and Build 🔧 # This example project is built using npm and outputs the result to the 'build' folder. Replace with the commands required to build your project, or remove this step entirely if your site is pre-built.
run: | run: |
@ -196,10 +209,11 @@ on:
- main - main
jobs: jobs:
deploy: deploy:
concurrency: ci-${{ github.ref }}
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout 🛎️ - name: Checkout 🛎️
uses: actions/checkout@v2.5.1 uses: actions/checkout@v2
- name: Install and Build 🔧 # This example project is built using npm and outputs the result to the 'build' folder. Replace with the commands required to build your project, or remove this step entirely if your site is pre-built. - name: Install and Build 🔧 # This example project is built using npm and outputs the result to the 'build' folder. Replace with the commands required to build your project, or remove this step entirely if your site is pre-built.
run: | run: |
@ -248,7 +262,7 @@ jobs:
runs-on: windows-latest # The first job utilizes windows-latest runs-on: windows-latest # The first job utilizes windows-latest
steps: steps:
- name: Checkout 🛎️ - name: Checkout 🛎️
uses: actions/checkout@v2.5.1 uses: actions/checkout@v2
- name: Install and Build 🔧 # This example project is built using npm and outputs the result to the 'build' folder. Replace with the commands required to build your project, or remove this step entirely if your site is pre-built. - name: Install and Build 🔧 # This example project is built using npm and outputs the result to the 'build' folder. Replace with the commands required to build your project, or remove this step entirely if your site is pre-built.
run: | run: |
@ -262,11 +276,12 @@ jobs:
path: build path: build
deploy: deploy:
concurrency: ci-${{ github.ref }}
needs: [build] # The second job must depend on the first one to complete before running, and uses ubuntu-latest instead of windows. needs: [build] # The second job must depend on the first one to complete before running, and uses ubuntu-latest instead of windows.
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout 🛎️ - name: Checkout 🛎️
uses: actions/checkout@v2.5.1 uses: actions/checkout@v2
- name: Download Artifacts 🔻 # The built project is downloaded into the 'site' folder. - name: Download Artifacts 🔻 # The built project is downloaded into the 'site' folder.
uses: actions/download-artifact@v1 uses: actions/download-artifact@v1
@ -315,10 +330,11 @@ on:
- main - main
jobs: jobs:
deploy: deploy:
concurrency: ci-${{ github.ref }}
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout 🛎️ - name: Checkout 🛎️
uses: actions/checkout@v2.5.1 uses: actions/checkout@v2
- name: Install and Build 🔧 # This example project is built using npm and outputs the result to the 'build' folder. Replace with the commands required to build your project, or remove this step entirely if your site is pre-built. - name: Install and Build 🔧 # This example project is built using npm and outputs the result to the 'build' folder. Replace with the commands required to build your project, or remove this step entirely if your site is pre-built.
run: | run: |
@ -340,11 +356,3 @@ jobs:
</details> </details>
If you wish to remove these files you must go into the deployment branch directly to remove them. This is to prevent accidental changes in your deployment script from creating breaking changes. If you wish to remove these files you must go into the deployment branch directly to remove them. This is to prevent accidental changes in your deployment script from creating breaking changes.
---
## Support 💖
This project would not be possible without all of our fantastic [contributors](https://github.com/JamesIves/github-pages-deploy-action/graphs/contributors) and [sponsors](https://github.com/sponsors/JamesIves). If you'd like to support the maintenance and upkeep of this project you can [donate via GitHub Sponsors](https://github.com/sponsors/JamesIves).
<!-- sponsors --><a href="https://github.com/milanpollock"><img src="https://github.com/milanpollock.png" width="50px" alt="" /></a><a href="https://github.com/raoulvdberge"><img src="https://github.com/raoulvdberge.png" width="50px" alt="" /></a><!-- sponsors -->

1
__tests__/env.js
View File

@ -1 +1,2 @@
process.env.ACTIONS_STEP_DEBUG = 'false' process.env.ACTIONS_STEP_DEBUG = 'false'
process.env.RUNNER_OS = 'Windows'

4
__tests__/main.test.ts
View File

@ -3,6 +3,7 @@ process.env['INPUT_FOLDER'] = 'build'
process.env['GITHUB_SHA'] = '123' process.env['GITHUB_SHA'] = '123'
process.env['INPUT_DEBUG'] = 'debug' process.env['INPUT_DEBUG'] = 'debug'
process.env['GITHUB_REF_NAME'] = 'test' process.env['GITHUB_REF_NAME'] = 'test'
process.env['RUNNER_OS'] = 'Linux'
import '../src/main' import '../src/main'
import {action, TestFlag} from '../src/constants' import {action, TestFlag} from '../src/constants'
@ -27,7 +28,8 @@ jest.mock('@actions/core', () => ({
setOutput: jest.fn(), setOutput: jest.fn(),
exportVariable: jest.fn(), exportVariable: jest.fn(),
isDebug: jest.fn(), isDebug: jest.fn(),
info: jest.fn() info: jest.fn(),
notice: jest.fn()
})) }))
describe('main', () => { describe('main', () => {

4
__tests__/util.test.ts
View File

@ -224,7 +224,7 @@ describe('util', () => {
checkParameters(action) checkParameters(action)
} catch (e) { } catch (e) {
expect(e instanceof Error && e.message).toMatch( expect(e instanceof Error && e.message).toMatch(
'No deployment token/method was provided. You must provide the action with either a Personal Access Token or the GitHub Token secret in order to deploy. If you wish to use an ssh deploy token then you must set SSH to true.' 'No deployment token/method was provided. You must provide the action with either a Personal Access Token or the GitHub Token secret in order to deploy. For more details on how to use an ssh deploy key please refer to the documentation.'
) )
} }
}) })
@ -244,7 +244,7 @@ describe('util', () => {
checkParameters(action) checkParameters(action)
} catch (e) { } catch (e) {
expect(e instanceof Error && e.message).toMatch( expect(e instanceof Error && e.message).toMatch(
'No deployment token/method was provided. You must provide the action with either a Personal Access Token or the GitHub Token secret in order to deploy. If you wish to use an ssh deploy token then you must set SSH to true.' 'No deployment token/method was provided. You must provide the action with either a Personal Access Token or the GitHub Token secret in order to deploy. For more details on how to use an ssh deploy key please refer to the documentation.'
) )
} }
}) })

8
package.json
View File

@ -2,7 +2,7 @@
"name": "@jamesives/github-pages-deploy-action", "name": "@jamesives/github-pages-deploy-action",
"description": "GitHub action for building a project and deploying it to GitHub pages.", "description": "GitHub action for building a project and deploying it to GitHub pages.",
"author": "James Ives <iam@jamesiv.es> (https://jamesiv.es)", "author": "James Ives <iam@jamesiv.es> (https://jamesiv.es)",
"version": "4.2.1", "version": "4.2.2",
"license": "MIT", "license": "MIT",
"main": "lib/lib.js", "main": "lib/lib.js",
"types": "lib/lib.d.ts", "types": "lib/lib.d.ts",
@ -40,18 +40,18 @@
}, },
"devDependencies": { "devDependencies": {
"@types/jest": "27.4.0", "@types/jest": "27.4.0",
"@types/node": "17.0.8", "@types/node": "17.0.13",
"@typescript-eslint/eslint-plugin": "4.33.0", "@typescript-eslint/eslint-plugin": "4.33.0",
"@typescript-eslint/parser": "4.33.0", "@typescript-eslint/parser": "4.33.0",
"eslint": "7.32.0", "eslint": "7.32.0",
"eslint-config-prettier": "8.3.0", "eslint-config-prettier": "8.3.0",
"eslint-plugin-jest": "25.3.4", "eslint-plugin-jest": "26.0.0",
"eslint-plugin-prettier": "4.0.0", "eslint-plugin-prettier": "4.0.0",
"jest": "26.6.3", "jest": "26.6.3",
"jest-circus": "27.4.6", "jest-circus": "27.4.6",
"prettier": "2.5.1", "prettier": "2.5.1",
"rimraf": "3.0.2", "rimraf": "3.0.2",
"ts-jest": "26.5.6", "ts-jest": "26.5.6",
"typescript": "4.5.4" "typescript": "4.5.5"
} }
} }

41
src/lib.ts
View File

@ -1,4 +1,4 @@
import {exportVariable, info, setFailed, setOutput} from '@actions/core' import {exportVariable, info, notice, setFailed, setOutput} from '@actions/core'
import {ActionInterface, NodeActionInterface, Status} from './constants' import {ActionInterface, NodeActionInterface, Status} from './constants'
import {deploy, init} from './git' import {deploy, init} from './git'
import {configureSSH} from './ssh' import {configureSSH} from './ssh'
@ -21,8 +21,25 @@ export default async function run(
try { try {
info(` info(`
GitHub Pages Deploy Action 🚀 ╭━━━╮╭╮╭╮╱╭╮╱╱╭╮╱╱╭━━━╮
┃╭━╮┣╯╰┫┃╱┃┃╱╱┃┃╱╱┃╭━╮┃
┃┃╱╰╋╮╭┫╰━╯┣╮╭┫╰━╮┃╰━╯┣━━┳━━┳━━┳━━╮
┃┃╭━╋┫┃┃╭━╮┃┃┃┃╭╮┃┃╭━━┫╭╮┃╭╮┃┃━┫━━┫
┃╰┻━┃┃╰┫┃╱┃┃╰╯┃╰╯┃┃┃╱╱┃╭╮┃╰╯┃┃━╋━━┃
╰━━━┻┻━┻╯╱╰┻━━┻━━╯╰╯╱╱╰╯╰┻━╮┣━━┻━━╯
╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╭━╯┃
╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╰━━╯
╭━━━╮╱╱╱╱╱╭╮╱╱╱╱╱╱╱╱╭━━━╮╱╱╭╮
╰╮╭╮┃╱╱╱╱╱┃┃╱╱╱╱╱╱╱╱┃╭━╮┃╱╭╯╰╮
╱┃┃┃┣━━┳━━┫┃╭━━┳╮╱╭╮┃┃╱┃┣━┻╮╭╋┳━━┳━╮
╱┃┃┃┃┃━┫╭╮┃┃┃╭╮┃┃╱┃┃┃╰━╯┃╭━┫┃┣┫╭╮┃╭╮╮
╭╯╰╯┃┃━┫╰╯┃╰┫╰╯┃╰━╯┃┃╭━╮┃╰━┫╰┫┃╰╯┃┃┃┃
╰━━━┻━━┫╭━┻━┻━━┻━╮╭╯╰╯╱╰┻━━┻━┻┻━━┻╯╰╯
╱╱╱╱╱╱╱┃┃╱╱╱╱╱╱╭━╯┃
╱╱╱╱╱╱╱╰╯╱╱╱╱╱╱╰━━╯
`)
info(`
💖 Support: https://github.com/sponsors/JamesIves 💖 Support: https://github.com/sponsors/JamesIves
📣 Maintained by James Ives: https://jamesiv.es 📣 Maintained by James Ives: https://jamesiv.es
@ -53,17 +70,19 @@ export default async function run(
status = await deploy(settings) status = await deploy(settings)
} catch (error) { } catch (error) {
status = Status.FAILED status = Status.FAILED
setFailed(extractErrorMessage(error)) setFailed(extractErrorMessage(error))
} finally { } finally {
info( const terminationMessage = `${
`${ status === Status.FAILED
status === Status.FAILED ? 'Deployment failed! ❌'
? 'Deployment failed! ❌' : status === Status.SUCCESS
: status === Status.SUCCESS ? 'Completed deployment successfully! ✅'
? 'Completed deployment successfully! ✅' : 'There is nothing to commit. Exiting early… 📭'
: 'There is nothing to commit. Exiting early… 📭' }`
}`
) info(terminationMessage)
notice(terminationMessage)
exportVariable('deployment_status', status) exportVariable('deployment_status', status)
setOutput('deployment-status', status) setOutput('deployment-status', status)

7
src/util.ts
View File

@ -1,4 +1,4 @@
import {isDebug, info} from '@actions/core' import {isDebug, warning} from '@actions/core'
import {existsSync} from 'fs' import {existsSync} from 'fs'
import path from 'path' import path from 'path'
import { import {
@ -47,6 +47,7 @@ const hasRequiredParameters = <K extends keyof RequiredActionParameters>(
const nonNullParams = params.filter( const nonNullParams = params.filter(
param => !isNullOrUndefined(action[param]) param => !isNullOrUndefined(action[param])
) )
return Boolean(nonNullParams.length) return Boolean(nonNullParams.length)
} }
@ -54,7 +55,7 @@ const hasRequiredParameters = <K extends keyof RequiredActionParameters>(
export const checkParameters = (action: ActionInterface): void => { export const checkParameters = (action: ActionInterface): void => {
if (!hasRequiredParameters(action, ['token', 'sshKey'])) { if (!hasRequiredParameters(action, ['token', 'sshKey'])) {
throw new Error( throw new Error(
'No deployment token/method was provided. You must provide the action with either a Personal Access Token or the GitHub Token secret in order to deploy. If you wish to use an ssh deploy token then you must set SSH to true.' 'No deployment token/method was provided. You must provide the action with either a Personal Access Token or the GitHub Token secret in order to deploy. For more details on how to use an ssh deploy key please refer to the documentation.'
) )
} }
@ -77,7 +78,7 @@ export const checkParameters = (action: ActionInterface): void => {
process.env.RUNNER_OS as OperatingSystems process.env.RUNNER_OS as OperatingSystems
) )
) { ) {
info( warning(
`The operating system you're using is not supported and results may be varied. Please refer to the documentation for more details. ❗` `The operating system you're using is not supported and results may be varied. Please refer to the documentation for more details. ❗`
) )
} }

117
yarn.lock
View File

@ -1258,10 +1258,10 @@
resolved "https://registry.yarnpkg.com/@types/json-schema/-/json-schema-7.0.9.tgz#97edc9037ea0c38585320b28964dde3b39e4660d" resolved "https://registry.yarnpkg.com/@types/json-schema/-/json-schema-7.0.9.tgz#97edc9037ea0c38585320b28964dde3b39e4660d"
integrity sha512-qcUXuemtEu+E5wZSJHNxUXeCZhAfXKQ41D+duX+VYPde7xyEVZci+/oXKJL13tnRs9lR2pr4fod59GT6/X1/yQ== integrity sha512-qcUXuemtEu+E5wZSJHNxUXeCZhAfXKQ41D+duX+VYPde7xyEVZci+/oXKJL13tnRs9lR2pr4fod59GT6/X1/yQ==
"@types/node@*", "@types/node@17.0.8", "@types/node@>= 8": "@types/node@*", "@types/node@17.0.13", "@types/node@>= 8":
version "17.0.8" version "17.0.13"
resolved "https://registry.yarnpkg.com/@types/node/-/node-17.0.8.tgz#50d680c8a8a78fe30abe6906453b21ad8ab0ad7b" resolved "https://registry.yarnpkg.com/@types/node/-/node-17.0.13.tgz#5ed7ed7c662948335fcad6c412bb42d99ea754e3"
integrity sha512-YofkM6fGv4gDJq78g4j0mMuGMkZVxZDgtU0JRdx6FgiJDG+0fY0GKVolOV8WqVmEhLCXkQRjwDdKyPxJp/uucg== integrity sha512-Y86MAxASe25hNzlDbsviXl8jQHb0RDvKt4c40ZJQ1Don0AAL0STLZSs4N+6gLEO55pedy7r2cLwS+ZDxPm/2Bw==
"@types/normalize-package-data@^2.4.0": "@types/normalize-package-data@^2.4.0":
version "2.4.0" version "2.4.0"
@ -1323,18 +1323,6 @@
eslint-scope "^5.1.1" eslint-scope "^5.1.1"
eslint-utils "^3.0.0" eslint-utils "^3.0.0"
"@typescript-eslint/experimental-utils@^5.0.0":
version "5.4.0"
resolved "https://registry.yarnpkg.com/@typescript-eslint/experimental-utils/-/experimental-utils-5.4.0.tgz#238a7418d2da3b24874ba35385eb21cc61d2a65e"
integrity sha512-Nz2JDIQUdmIGd6p33A+naQmwfkU5KVTLb/5lTk+tLVTDacZKoGQisj8UCxk7onJcrgjIvr8xWqkYI+DbI3TfXg==
dependencies:
"@types/json-schema" "^7.0.9"
"@typescript-eslint/scope-manager" "5.4.0"
"@typescript-eslint/types" "5.4.0"
"@typescript-eslint/typescript-estree" "5.4.0"
eslint-scope "^5.1.1"
eslint-utils "^3.0.0"
"@typescript-eslint/parser@4.33.0": "@typescript-eslint/parser@4.33.0":
version "4.33.0" version "4.33.0"
resolved "https://registry.yarnpkg.com/@typescript-eslint/parser/-/parser-4.33.0.tgz#dfe797570d9694e560528d18eecad86c8c744899" resolved "https://registry.yarnpkg.com/@typescript-eslint/parser/-/parser-4.33.0.tgz#dfe797570d9694e560528d18eecad86c8c744899"
@ -1353,23 +1341,23 @@
"@typescript-eslint/types" "4.33.0" "@typescript-eslint/types" "4.33.0"
"@typescript-eslint/visitor-keys" "4.33.0" "@typescript-eslint/visitor-keys" "4.33.0"
"@typescript-eslint/scope-manager@5.4.0": "@typescript-eslint/scope-manager@5.10.1":
version "5.4.0" version "5.10.1"
resolved "https://registry.yarnpkg.com/@typescript-eslint/scope-manager/-/scope-manager-5.4.0.tgz#aaab08415f4a9cf32b870c7750ae8ba4607126a1" resolved "https://registry.yarnpkg.com/@typescript-eslint/scope-manager/-/scope-manager-5.10.1.tgz#f0539c73804d2423506db2475352a4dec36cd809"
integrity sha512-pRxFjYwoi8R+n+sibjgF9iUiAELU9ihPBtHzocyW8v8D8G8KeQvXTsW7+CBYIyTYsmhtNk50QPGLE3vrvhM5KA== integrity sha512-Lyvi559Gvpn94k7+ElXNMEnXu/iundV5uFmCUNnftbFrUbAJ1WBoaGgkbOBm07jVZa682oaBU37ao/NGGX4ZDg==
dependencies: dependencies:
"@typescript-eslint/types" "5.4.0" "@typescript-eslint/types" "5.10.1"
"@typescript-eslint/visitor-keys" "5.4.0" "@typescript-eslint/visitor-keys" "5.10.1"
"@typescript-eslint/types@4.33.0": "@typescript-eslint/types@4.33.0":
version "4.33.0" version "4.33.0"
resolved "https://registry.yarnpkg.com/@typescript-eslint/types/-/types-4.33.0.tgz#a1e59036a3b53ae8430ceebf2a919dc7f9af6d72" resolved "https://registry.yarnpkg.com/@typescript-eslint/types/-/types-4.33.0.tgz#a1e59036a3b53ae8430ceebf2a919dc7f9af6d72"
integrity sha512-zKp7CjQzLQImXEpLt2BUw1tvOMPfNoTAfb8l51evhYbOEEzdWyQNmHWWGPR6hwKJDAi+1VXSBmnhL9kyVTTOuQ== integrity sha512-zKp7CjQzLQImXEpLt2BUw1tvOMPfNoTAfb8l51evhYbOEEzdWyQNmHWWGPR6hwKJDAi+1VXSBmnhL9kyVTTOuQ==
"@typescript-eslint/types@5.4.0": "@typescript-eslint/types@5.10.1":
version "5.4.0" version "5.10.1"
resolved "https://registry.yarnpkg.com/@typescript-eslint/types/-/types-5.4.0.tgz#b1c130f4b381b77bec19696c6e3366f9781ce8f2" resolved "https://registry.yarnpkg.com/@typescript-eslint/types/-/types-5.10.1.tgz#dca9bd4cb8c067fc85304a31f38ec4766ba2d1ea"
integrity sha512-GjXNpmn+n1LvnttarX+sPD6+S7giO+9LxDIGlRl4wK3a7qMWALOHYuVSZpPTfEIklYjaWuMtfKdeByx0AcaThA== integrity sha512-ZvxQ2QMy49bIIBpTqFiOenucqUyjTQ0WNLhBM6X1fh1NNlYAC6Kxsx8bRTY3jdYsYg44a0Z/uEgQkohbR0H87Q==
"@typescript-eslint/typescript-estree@4.33.0": "@typescript-eslint/typescript-estree@4.33.0":
version "4.33.0" version "4.33.0"
@ -1384,19 +1372,31 @@
semver "^7.3.5" semver "^7.3.5"
tsutils "^3.21.0" tsutils "^3.21.0"
"@typescript-eslint/typescript-estree@5.4.0": "@typescript-eslint/typescript-estree@5.10.1":
version "5.4.0" version "5.10.1"
resolved "https://registry.yarnpkg.com/@typescript-eslint/typescript-estree/-/typescript-estree-5.4.0.tgz#fe524fb308973c68ebeb7428f3b64499a6ba5fc0" resolved "https://registry.yarnpkg.com/@typescript-eslint/typescript-estree/-/typescript-estree-5.10.1.tgz#b268e67be0553f8790ba3fe87113282977adda15"
integrity sha512-nhlNoBdhKuwiLMx6GrybPT3SFILm5Gij2YBdPEPFlYNFAXUJWX6QRgvi/lwVoadaQEFsizohs6aFRMqsXI2ewA== integrity sha512-PwIGnH7jIueXv4opcwEbVGDATjGPO1dx9RkUl5LlHDSe+FXxPwFL5W/qYd5/NHr7f6lo/vvTrAzd0KlQtRusJQ==
dependencies: dependencies:
"@typescript-eslint/types" "5.4.0" "@typescript-eslint/types" "5.10.1"
"@typescript-eslint/visitor-keys" "5.4.0" "@typescript-eslint/visitor-keys" "5.10.1"
debug "^4.3.2" debug "^4.3.2"
globby "^11.0.4" globby "^11.0.4"
is-glob "^4.0.3" is-glob "^4.0.3"
semver "^7.3.5" semver "^7.3.5"
tsutils "^3.21.0" tsutils "^3.21.0"
"@typescript-eslint/utils@^5.10.0":
version "5.10.1"
resolved "https://registry.yarnpkg.com/@typescript-eslint/utils/-/utils-5.10.1.tgz#fa682a33af47080ba2c4368ee0ad2128213a1196"
integrity sha512-RRmlITiUbLuTRtn/gcPRi4202niF+q7ylFLCKu4c+O/PcpRvZ/nAUwQ2G00bZgpWkhrNLNnvhZLbDn8Ml0qsQw==
dependencies:
"@types/json-schema" "^7.0.9"
"@typescript-eslint/scope-manager" "5.10.1"
"@typescript-eslint/types" "5.10.1"
"@typescript-eslint/typescript-estree" "5.10.1"
eslint-scope "^5.1.1"
eslint-utils "^3.0.0"
"@typescript-eslint/visitor-keys@4.33.0": "@typescript-eslint/visitor-keys@4.33.0":
version "4.33.0" version "4.33.0"
resolved "https://registry.yarnpkg.com/@typescript-eslint/visitor-keys/-/visitor-keys-4.33.0.tgz#2a22f77a41604289b7a186586e9ec48ca92ef1dd" resolved "https://registry.yarnpkg.com/@typescript-eslint/visitor-keys/-/visitor-keys-4.33.0.tgz#2a22f77a41604289b7a186586e9ec48ca92ef1dd"
@ -1405,12 +1405,12 @@
"@typescript-eslint/types" "4.33.0" "@typescript-eslint/types" "4.33.0"
eslint-visitor-keys "^2.0.0" eslint-visitor-keys "^2.0.0"
"@typescript-eslint/visitor-keys@5.4.0": "@typescript-eslint/visitor-keys@5.10.1":
version "5.4.0" version "5.10.1"
resolved "https://registry.yarnpkg.com/@typescript-eslint/visitor-keys/-/visitor-keys-5.4.0.tgz#09bc28efd3621f292fe88c86eef3bf4893364c8c" resolved "https://registry.yarnpkg.com/@typescript-eslint/visitor-keys/-/visitor-keys-5.10.1.tgz#29102de692f59d7d34ecc457ed59ab5fc558010b"
integrity sha512-PVbax7MeE7tdLfW5SA0fs8NGVVr+buMPrcj+CWYWPXsZCH8qZ1THufDzbXm1xrZ2b2PA1iENJ0sRq5fuUtvsJg== integrity sha512-NjQ0Xinhy9IL979tpoTRuLKxMc0zJC7QVSdeerXs2/QvOy2yRkzX5dRb10X5woNUdJgU8G3nYRDlI33sq1K4YQ==
dependencies: dependencies:
"@typescript-eslint/types" "5.4.0" "@typescript-eslint/types" "5.10.1"
eslint-visitor-keys "^3.0.0" eslint-visitor-keys "^3.0.0"
abab@^2.0.3: abab@^2.0.3:
@ -2137,12 +2137,12 @@ eslint-config-prettier@8.3.0:
resolved "https://registry.yarnpkg.com/eslint-config-prettier/-/eslint-config-prettier-8.3.0.tgz#f7471b20b6fe8a9a9254cc684454202886a2dd7a" resolved "https://registry.yarnpkg.com/eslint-config-prettier/-/eslint-config-prettier-8.3.0.tgz#f7471b20b6fe8a9a9254cc684454202886a2dd7a"
integrity sha512-BgZuLUSeKzvlL/VUjx/Yb787VQ26RU3gGjA3iiFvdsp/2bMfVIWUVP7tjxtjS0e+HP409cPlPvNkQloz8C91ew== integrity sha512-BgZuLUSeKzvlL/VUjx/Yb787VQ26RU3gGjA3iiFvdsp/2bMfVIWUVP7tjxtjS0e+HP409cPlPvNkQloz8C91ew==
eslint-plugin-jest@25.3.4: eslint-plugin-jest@26.0.0:
version "25.3.4" version "26.0.0"
resolved "https://registry.yarnpkg.com/eslint-plugin-jest/-/eslint-plugin-jest-25.3.4.tgz#2031dfe495be1463330f8b80096ddc91f8e6387f" resolved "https://registry.yarnpkg.com/eslint-plugin-jest/-/eslint-plugin-jest-26.0.0.tgz#f83a25a23ab90ce5b375b1d44389b8c391be5ce8"
integrity sha512-CCnwG71wvabmwq/qkz0HWIqBHQxw6pXB1uqt24dxqJ9WB34pVg49bL1sjXphlJHgTMWGhBjN1PicdyxDxrfP5A== integrity sha512-Fvs0YgJ/nw9FTrnqTuMGVrkozkd07jkQzWm0ajqyHlfcsdkxGfAuv30fgfWHOnHiCr9+1YQ365CcDX7vrNhqQg==
dependencies: dependencies:
"@typescript-eslint/experimental-utils" "^5.0.0" "@typescript-eslint/utils" "^5.10.0"
eslint-plugin-prettier@4.0.0: eslint-plugin-prettier@4.0.0:
version "4.0.0" version "4.0.0"
@ -3888,8 +3888,11 @@ nice-try@^1.0.4:
resolved "https://registry.yarnpkg.com/nice-try/-/nice-try-1.0.5.tgz#a3378a7696ce7d223e88fc9b764bd7ef1089e366" resolved "https://registry.yarnpkg.com/nice-try/-/nice-try-1.0.5.tgz#a3378a7696ce7d223e88fc9b764bd7ef1089e366"
node-fetch@^2.3.0, node-fetch@^2.6.1: node-fetch@^2.3.0, node-fetch@^2.6.1:
version "2.6.1" version "2.6.7"
resolved "https://registry.yarnpkg.com/node-fetch/-/node-fetch-2.6.1.tgz#045bd323631f76ed2e2b55573394416b639a0052" 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-int64@^0.4.0: node-int64@^0.4.0:
version "0.4.0" version "0.4.0"
@ -4782,6 +4785,11 @@ tr46@^2.0.0:
dependencies: dependencies:
punycode "^2.1.1" 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=
ts-jest@26.5.6: ts-jest@26.5.6:
version "26.5.6" version "26.5.6"
resolved "https://registry.yarnpkg.com/ts-jest/-/ts-jest-26.5.6.tgz#c32e0746425274e1dfe333f43cd3c800e014ec35" resolved "https://registry.yarnpkg.com/ts-jest/-/ts-jest-26.5.6.tgz#c32e0746425274e1dfe333f43cd3c800e014ec35"
@ -4857,10 +4865,10 @@ typedarray-to-buffer@^3.1.5:
dependencies: dependencies:
is-typedarray "^1.0.0" is-typedarray "^1.0.0"
typescript@4.5.4: typescript@4.5.5:
version "4.5.4" version "4.5.5"
resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.5.4.tgz#a17d3a0263bf5c8723b9c52f43c5084edf13c2e8" resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.5.5.tgz#d8c953832d28924a9e3d37c73d729c846c5896f3"
integrity sha512-VgYs2A2QIRuGphtzFV7aQJduJ2gyfTljngLzjpfW9FoYZF6xuw1W0vW9ghCKLfcWrCFxK81CSGRAvS1pn4fIUg== integrity sha512-TCTIul70LyWe6IJWT8QSYeA54WQe8EjQFU4wY52Fasj5UKx88LNYKCgBEHcOMOrFF1rKGbD8v/xcNWVUq9SymA==
union-value@^1.0.0: union-value@^1.0.0:
version "1.0.1" version "1.0.1"
@ -4962,6 +4970,11 @@ walker@^1.0.7, walker@~1.0.5:
dependencies: dependencies:
makeerror "1.0.x" makeerror "1.0.x"
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: webidl-conversions@^5.0.0:
version "5.0.0" version "5.0.0"
resolved "https://registry.yarnpkg.com/webidl-conversions/-/webidl-conversions-5.0.0.tgz#ae59c8a00b121543a2acc65c0434f57b0fc11aff" resolved "https://registry.yarnpkg.com/webidl-conversions/-/webidl-conversions-5.0.0.tgz#ae59c8a00b121543a2acc65c0434f57b0fc11aff"
@ -4980,6 +4993,14 @@ whatwg-mimetype@^2.3.0:
version "2.3.0" version "2.3.0"
resolved "https://registry.yarnpkg.com/whatwg-mimetype/-/whatwg-mimetype-2.3.0.tgz#3d4b1e0312d2079879f826aff18dbeeca5960fbf" resolved "https://registry.yarnpkg.com/whatwg-mimetype/-/whatwg-mimetype-2.3.0.tgz#3d4b1e0312d2079879f826aff18dbeeca5960fbf"
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.0.0:
version "8.0.0" version "8.0.0"
resolved "https://registry.yarnpkg.com/whatwg-url/-/whatwg-url-8.0.0.tgz#37f256cb746398e19b107bd6ef820b4ae2d15871" resolved "https://registry.yarnpkg.com/whatwg-url/-/whatwg-url-8.0.0.tgz#37f256cb746398e19b107bd6ef820b4ae2d15871"