Skip to content

Commit 68a346e

Browse files
xbill82xbill82
authored
Latest kuzdoc minor and dead-link check (#645)
Following the latest improvements in the Docs CI workflow, we need to have isomorphic dependencies (thus `npm ci`) but the latest Kuzdoc minor within the major specified by `package.json` (thus `npm i kuzdoc`). Having the latest minor of Kuzdoc enables us to easily deploy non-breaking changes to all the CIs without manually bump the Kuzdoc dependency (which would be the case if we just`npm ci`). Also, this PR re-activates the dead-link check, using the SSH-key.
1 parent ea54b9f commit 68a346e

File tree

3 files changed

+95
-88
lines changed

3 files changed

+95
-88
lines changed

‎.github/actions/dead-links/action.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,10 @@ runs:
44
using: "composite"
55
steps:
66
- name: Install deps
7-
run: npm ci
7+
run: npm ci --production=false
8+
shell: bash
9+
- name: Install latest minor of Kuzdoc
10+
run: npm i --save-dev kuzdoc
811
shell: bash
912
- name: Prepare documentation
1013
run: npm run doc-prepare

‎.github/actions/doc-deploy/action.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ runs:
3333
- name: Build documentation
3434
run: |
3535
rm -fr doc/framework
36-
npm install --production=false
36+
npm ci --production=false
37+
npm i --save-dev kuzdoc
3738
npm run doc-prepare
3839
npm run doc-build
3940
env:

‎.github/workflows/push_master.workflow.yml

Lines changed: 89 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -28,51 +28,51 @@ jobs:
2828
- uses: ./.github/actions/es-lint
2929

3030
unit-tests:
31-
name: Unit Tests
32-
runs-on: ubuntu-18.04
33-
needs: [lint]
34-
steps:
35-
- uses: actions/checkout@v2
36-
- name: Cache node modules
37-
uses: actions/cache@v2
38-
env:
39-
cache-name: cache-node-modules
40-
with:
41-
path: ~/.npm
42-
key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
43-
restore-keys: |
44-
${{ runner.os }}-build-${{ env.cache-name }}-
45-
${{ runner.os }}-build-
46-
${{ runner.os }}-
47-
- uses: actions/[email protected]
48-
with:
49-
node-version: "12"
50-
- uses: ./.github/actions/unit-tests
31+
name: Unit Tests
32+
runs-on: ubuntu-18.04
33+
needs: [lint]
34+
steps:
35+
- uses: actions/checkout@v2
36+
- name: Cache node modules
37+
uses: actions/cache@v2
38+
env:
39+
cache-name: cache-node-modules
40+
with:
41+
path: ~/.npm
42+
key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
43+
restore-keys: |
44+
${{ runner.os }}-build-${{ env.cache-name }}-
45+
${{ runner.os }}-build-
46+
${{ runner.os }}-
47+
- uses: actions/[email protected]
48+
with:
49+
node-version: "12"
50+
- uses: ./.github/actions/unit-tests
5151

5252
functional-tests:
53-
name: Functional Tests
54-
runs-on: ubuntu-18.04
55-
needs: [unit-tests]
56-
steps:
57-
- uses: actions/checkout@v2
58-
with:
59-
submodules: 'recursive'
60-
- name: Cache node modules
61-
uses: actions/cache@v2
62-
env:
63-
cache-name: cache-node-modules
64-
with:
65-
path: ~/.npm
66-
key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
67-
restore-keys: |
68-
${{ runner.os }}-build-${{ env.cache-name }}-
69-
${{ runner.os }}-build-
70-
${{ runner.os }}-
71-
- uses: actions/[email protected]
72-
with:
73-
node-version: "12"
74-
- uses: ./.github/actions/functional-tests
75-
with:
53+
name: Functional Tests
54+
runs-on: ubuntu-18.04
55+
needs: [unit-tests]
56+
steps:
57+
- uses: actions/checkout@v2
58+
with:
59+
submodules: "recursive"
60+
- name: Cache node modules
61+
uses: actions/cache@v2
62+
env:
63+
cache-name: cache-node-modules
64+
with:
65+
path: ~/.npm
66+
key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
67+
restore-keys: |
68+
${{ runner.os }}-build-${{ env.cache-name }}-
69+
${{ runner.os }}-build-
70+
${{ runner.os }}-
71+
- uses: actions/[email protected]
72+
with:
73+
node-version: "12"
74+
- uses: ./.github/actions/functional-tests
75+
with:
7676
CYPRESS_RECORD_KEY_DOC: ${{ secrets.CYPRESS_RECORD_KEY_DOC }}
7777

7878
# admin-console-tests:
@@ -100,49 +100,52 @@ jobs:
100100
# sdk-version: 7
101101
# cypress-key: ${{ secrets.CYPRESS_RECORD_KEY }}
102102

103-
# documentation-dead-links:
104-
# name: Dead links
105-
# runs-on: ubuntu-18.04
106-
# steps:
107-
# - uses: actions/checkout@v2
108-
# - name: Cache node modules
109-
# uses: actions/cache@v2
110-
# env:
111-
# cache-name: cache-node-modules
112-
# with:
113-
# path: ~/.npm
114-
# key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
115-
# restore-keys: |
116-
# ${{ runner.os }}-build-${{ env.cache-name }}-
117-
# ${{ runner.os }}-build-
118-
# ${{ runner.os }}-
119-
# - uses: actions/[email protected]
120-
# with:
121-
# node-version: "12"
122-
# - uses: ./.github/actions/dead-links
103+
documentation-dead-links:
104+
name: Dead links
105+
runs-on: ubuntu-18.04
106+
steps:
107+
- uses: actions/checkout@v2
108+
- name: Cache node modules
109+
uses: actions/cache@v2
110+
env:
111+
cache-name: cache-node-modules
112+
with:
113+
path: ~/.npm
114+
key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
115+
restore-keys: |
116+
${{ runner.os }}-build-${{ env.cache-name }}-
117+
${{ runner.os }}-build-
118+
${{ runner.os }}-
119+
- uses: actions/[email protected]
120+
with:
121+
node-version: "12"
122+
- uses: webfactory/[email protected]
123+
with:
124+
ssh-private-key: ${{ secrets.SSH_KEY }}
125+
- uses: ./.github/actions/dead-links
123126

124127
documentation-snippet-tests:
125-
name: Documentation Snippet Tests
126-
needs: [unit-tests]
127-
runs-on: ubuntu-18.04
128-
steps:
129-
- uses: actions/checkout@v2
130-
- name: Cache node modules
131-
uses: actions/cache@v2
132-
env:
133-
cache-name: cache-node-modules
134-
with:
135-
path: ~/.npm
136-
key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
137-
restore-keys: |
138-
${{ runner.os }}-build-${{ env.cache-name }}-
139-
${{ runner.os }}-build-
140-
${{ runner.os }}-
141-
- uses: actions/[email protected]
142-
with:
143-
node-version: "12"
144-
- uses: ./.github/actions/snippet-tests
145-
with:
128+
name: Documentation Snippet Tests
129+
needs: [unit-tests]
130+
runs-on: ubuntu-18.04
131+
steps:
132+
- uses: actions/checkout@v2
133+
- name: Cache node modules
134+
uses: actions/cache@v2
135+
env:
136+
cache-name: cache-node-modules
137+
with:
138+
path: ~/.npm
139+
key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
140+
restore-keys: |
141+
${{ runner.os }}-build-${{ env.cache-name }}-
142+
${{ runner.os }}-build-
143+
${{ runner.os }}-
144+
- uses: actions/[email protected]
145+
with:
146+
node-version: "12"
147+
- uses: ./.github/actions/snippet-tests
148+
with:
146149
CYPRESS_RECORD_KEY_DOC: ${{ secrets.CYPRESS_RECORD_KEY_DOC }}
147150

148151
documentation-production:
@@ -196,8 +199,8 @@ jobs:
196199
${{ runner.os }}-
197200
- uses: actions/setup-node@v1
198201
with:
199-
node-version: '12.x'
200-
registry-url: 'https://registry.npmjs.org'
202+
node-version: "12.x"
203+
registry-url: "https://registry.npmjs.org"
201204
- run: npm install
202205
- run: npm publish
203206
env:

0 commit comments

Comments
 (0)