Skip to content

Commit dcbd7c7

Browse files
Added api documentation deployment github action (#25)
1 parent 0a72423 commit dcbd7c7

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

.github/workflows/www-esdoc.yml

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: Deploy esdoc to os-js.org
2+
on:
3+
push:
4+
tags:
5+
- 3.*
6+
jobs:
7+
build:
8+
if: github.actor == 'andersevenrud' || github.actor == 'os-js'
9+
name: Build and deploy
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v2
13+
- name: Dependencies
14+
run: |
15+
sudo npm install -g \
16+
esdoc \
17+
esdoc-standard-plugin \
18+
esdoc-publish-html-plugin \
19+
esdoc-lint-plugin \
20+
esdoc-coverage-plugin \
21+
esdoc-accessor-plugin \
22+
esdoc-type-inference-plugin \
23+
esdoc-external-ecmascript-plugin \
24+
esdoc-brand-plugin \
25+
esdoc-undocumented-identifier-plugin \
26+
esdoc-unexported-identifier-plugin \
27+
esdoc-integrate-test-plugin \
28+
esdoc-integrate-manual-plugin
29+
- name: Build
30+
run: esdoc
31+
- name: Deploy
32+
uses: AEnterprise/rsync-deploy@v1.0
33+
env:
34+
DEPLOY_KEY: ${{ secrets.DOC_RSYNC_SSH_KEY }}
35+
ARGS: "-r --delete-after --quiet"
36+
SERVER_PORT: ${{ secrets.DOC_RSYNC_SSH_PORT }}
37+
FOLDER: "./doc/*"
38+
SERVER_IP: ${{ secrets.DOC_RSYNC_SSH_IP }}
39+
USERNAME: ${{ secrets.DOC_RSYNC_SSH_USERNAME }}
40+
SERVER_DESTINATION: ${{ secrets.DOC_RSYNC_SSH_PATH }}

0 commit comments

Comments
 (0)