thunderstrike/puppeteer
thunderstrike/puppeteer
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

chore(docs): setup placeholder workflow (#7434)

Browse Source
This commit is contained in:
Jack Franklin 2021-07-21 14:59:12 +01:00 committed by GitHub
parent c65b10c524
commit dab541a84d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 41 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
.github/workflows/deploy-docs.yml vendored Normal file
View File

@ -0,0 +1,31 @@
name: Build and deploy documentation
on:
push:
branches:
- main
jobs:
build-and-deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Build
run: |
npm install
# This will be replaced with the actual documentation builder once it's
# configured
mkdir -p docs-dist/
cp website/index.html docs-dist/index.html
- name: Set up SSH
uses: webfactory/ssh-agent@v0.4.1
with:
ssh-private-key: ${{ secrets.SSH_PRIVATE_KEY }}
- name: Deploy
uses: JamesIves/github-pages-deploy-action@releases/v3
with:
SSH: true
SINGLE_COMMIT: true
BASE_BRANCH: main
BRANCH: gh-pages
FOLDER: docs-dist

1
.gitignore vendored
View File

@ -21,3 +21,4 @@ temp/
new-docs/ new-docs/
puppeteer.tgz puppeteer.tgz
docs-api-json/ docs-api-json/
docs-dist/

9
website/index.html Normal file
View File

@ -0,0 +1,9 @@
<!DOCTYPE html>
<html>
<head>
<title>Puppeteer Documentation</title>
</head>
<body>
<h1>Hello world</h1>
</body>
</html>