forked from handsontable/handsontable
-
Notifications
You must be signed in to change notification settings - Fork 0
86 lines (70 loc) · 2.72 KB
/
docs-staging.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
name: Docs Staging Deployment
env:
GHA_DOCKER_TAG_NEXT: docker.pkg.github.com/${{ github.repository }}/handsontable-documentation:next
GHA_DOCKER_TAG_SHA: docker.pkg.github.com/${{ github.repository }}/handsontable-documentation:${{ github.sha }}
NODE_VERSION: 16
on:
push:
branches-ignore:
- 'prod-docs/**'
- 'master'
paths:
- 'docs/**'
workflow_dispatch:
defaults:
run:
working-directory: ./docs/
jobs:
docker:
name: Build and push Docker image
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # https://github.com/actions/checkout/releases/tag/v3.1.0
- name: Use Node.js ${{ env.NODE_VERSION }}
uses: actions/setup-node@8c91899e586c5b171469028077307d293428b516 # https://github.com/actions/setup-node/releases/tag/v3.5.1
with:
node-version: ${{ env.NODE_VERSION }}
cache: 'npm'
- name: Docker login into GHCR
run: |
echo "${{ secrets.GITHUB_TOKEN }}" | docker login -u ${GITHUB_ACTOR} --password-stdin https://docker.pkg.github.com
- name: Dependencies
run: |
npm ci
- name: Generate API references
run: |
npm run docs:api
- name: Docker build (for staging deployment)
if: ${{ github.event_name == 'workflow_dispatch' }}
run: |
npm run docs:docker:build:staging
- name: Docker build (for local testing)
if: ${{ github.event_name != 'workflow_dispatch' }}
run: |
npm run docs:docker:build:testing
- name: Test examples
run: |
npm run docs:test:example-checker
- name: Docker tags
run: |
docker tag docs-md $GHA_DOCKER_TAG_NEXT
docker tag docs-md $GHA_DOCKER_TAG_SHA
- name: Docker push "next" into GHCR and deploy to the staging (only when manually dispatched)
if: ${{ github.event_name == 'workflow_dispatch' }}
run: |
docker push ${GHA_DOCKER_TAG_NEXT}
- name: Docker push SHA tagged into GHCR
run: |
docker push ${GHA_DOCKER_TAG_SHA}
- name: Find PR
uses: jwalton/gh-find-current-pr@7ada613939e2a233c83a1320679446fa1c6bdcb9 # https://github.com/jwalton/gh-find-current-pr/tree/v1.3.2
id: pr-finder
- name: Publish sticky comment in PR
uses: marocchino/sticky-pull-request-comment@adca94abcaf73c10466a71cc83ae561fd66d1a56 # https://github.com/marocchino/sticky-pull-request-comment/tree/v2.3.0
with:
number: ${{ steps.pr-finder.outputs.pr }}
message: |
Launch the local version of documentation by running:
```bash
npm run docs:review ${{ github.sha }}
```