Skip to content

Commit fe7301b

Browse files
kefranabgkefranabg
authored
feat: Improve CI process (#1759)
1 parent 3b68913 commit fe7301b

File tree

3 files changed

+136
-36
lines changed

3 files changed

+136
-36
lines changed

‎.circleci/config.yml

+122-24
Original file line numberDiff line numberDiff line change
@@ -2,36 +2,134 @@
22
#
33
# Check https://circleci.com/docs/2.0/language-javascript/ for more details
44
#
5-
version: 2
5+
version: 2.1
6+
7+
defaults: &defaults
8+
working_directory: ~/project
9+
docker:
10+
- image: circleci/node:latest
11+
612
jobs:
7-
build:
8-
docker:
9-
# specify the version you desire here
10-
- image: circleci/node:10.15.2
1113

12-
# Specify service dependencies here if necessary
13-
# CircleCI maintains a library of pre-built images
14-
# documented at https://circleci.com/docs/2.0/circleci-images/
15-
# - image: circleci/mongo:3.4.4
14+
#------------------------------------------------------------
15+
# 1. Install dependencies
16+
#------------------------------------------------------------
17+
18+
install-dependencies:
19+
<<: *defaults
20+
steps:
21+
- checkout
22+
23+
- restore_cache:
24+
keys:
25+
- v1-deps-{{ checksum "yarn.lock" }}
26+
- v1-deps
27+
28+
- run:
29+
name: 'Install dependencies'
30+
command: yarn --frozen-lockfile --non-interactive
31+
32+
- save_cache:
33+
key: v1-deps-{{ checksum "yarn.lock" }}
34+
paths:
35+
- ~/.cache/yarn
36+
37+
- persist_to_workspace:
38+
root: ~/project
39+
paths:
40+
- node_modules
41+
- packages/*/node_modules
42+
- packages/@vuepress/*/node_modules
43+
44+
#------------------------------------------------------------
45+
# 2. Run parallel jobs:
46+
# => lerna-boostrap
47+
# => tsc
48+
# => tests
49+
# => linter
50+
# => docs linter
51+
#------------------------------------------------------------
1652

17-
working_directory: ~/repo
53+
lerna-bootstrap:
54+
<<: *defaults
55+
steps:
56+
- checkout
57+
- attach_workspace:
58+
at: ~/project
59+
- run:
60+
name: 'Lerna bootstrap'
61+
command: yarn lerna:bootstrap
62+
63+
run-tsc:
64+
<<: *defaults
65+
steps:
66+
- checkout
67+
- attach_workspace:
68+
at: ~/project
69+
- run:
70+
name: 'Run tsc'
71+
command: yarn tsc
72+
- persist_to_workspace:
73+
root: ~/project
74+
paths:
75+
- packages/@vuepress/shared-utils/lib
1876

77+
run-tests:
78+
<<: *defaults
1979
steps:
20-
- checkout
80+
- checkout
81+
- attach_workspace:
82+
at: ~/project
83+
- run:
84+
name: 'Run tests'
85+
command: yarn test
2186

22-
# Download and cache dependencies
23-
- restore_cache:
24-
keys:
25-
- v1-dependencies-{{ checksum "package.json" }}
26-
# fallback to using the latest cache if no exact match is found
27-
- v1-dependencies-
87+
run-linter-check:
88+
<<: *defaults
89+
steps:
90+
- checkout
91+
- attach_workspace:
92+
at: ~/project
93+
- run:
94+
name: 'Run linter'
95+
command: yarn lint:check
96+
97+
run-docs-linter-check:
98+
<<: *defaults
99+
steps:
100+
- checkout
101+
- attach_workspace:
102+
at: ~/project
103+
- run:
104+
name: 'Run md linter'
105+
command: yarn workspace docs lint-md
106+
107+
#------------------------------------------------------------
108+
# 3. Build VuePress
109+
#------------------------------------------------------------
28110

29-
- run: yarn bootstrap
111+
build:
112+
<<: *defaults
113+
steps:
114+
- checkout
115+
- attach_workspace:
116+
at: ~/project
117+
- run:
118+
name: 'Run tests'
119+
command: yarn build
30120

31-
- save_cache:
32-
paths:
33-
- node_modules
34-
key: v1-dependencies-{{ checksum "package.json" }}
121+
#------------------------------------------------------------
122+
# Workflows
123+
#------------------------------------------------------------
35124

36-
# run tests!
37-
- run: yarn build && yarn lint && yarn test
125+
workflows:
126+
version: 2
127+
build:
128+
jobs:
129+
- install-dependencies
130+
- lerna-bootstrap: { requires: [install-dependencies] }
131+
- run-linter-check: { requires: [install-dependencies] }
132+
- run-docs-linter-check: { requires: [install-dependencies] }
133+
- run-tsc: { requires: [install-dependencies] }
134+
- run-tests: { requires: [run-tsc] }
135+
- build: { requires: [run-tests, run-linter-check, run-docs-linter-check, lerna-bootstrap] }

‎package.json

+4-2
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
"scripts": {
1010
"precommit": "lint-staged",
1111
"bootstrap": "yarn && yarn tsc",
12+
"lerna:bootstrap": "lerna bootstrap",
1213
"clean": "lerna clean && rm -rf node_modules",
1314
"packages:list": "lerna ls -l",
1415
"packages:diff": "lerna diff",
@@ -22,9 +23,10 @@
2223
"view-info": "yarn tsc && yarn workspace docs view-info",
2324
"show-help": "yarn workspace docs show-help",
2425
"register-vuepress": "lerna exec --scope vuepress -- yarn link",
26+
"lint": "yarn lint:check --fix",
27+
"lint:check": "eslint packages --ext .js,.vue",
28+
"release": "yarn --pure-lockfile && yarn tsc && node scripts/release.js",
2529
"unregister-vuepress": "lerna exec --scope vuepress -- yarn unlink",
26-
"lint": "eslint packages --fix --ext .js,.vue",
27-
"release": "yarn --pure-lockfile && yarn tsc && node scripts/release.js",
2830
"changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 2",
2931
"test": "node scripts/test.js",
3032
"tsc": "yarn workspace @vuepress/shared-utils tsc"

‎packages/docs/docs/miscellaneous/local-development.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,21 @@ sidebar: auto
66

77
## Informations
88

9-
If you here youh may be intereset of improve core vuepress.
9+
If you here youh may be intereset of improve core VuePress.
1010

11-
Vuepress is using a combo with [Yarn workspaces](https://yarnpkg.com/lang/en/docs/workspaces/) and [Lerna](https://github.com/lerna/lerna).
11+
VuePress is using a combo with [Yarn workspaces](https://yarnpkg.com/lang/en/docs/workspaces/) and [Lerna](https://github.com/lerna/lerna).
1212

1313
## Init packages
1414

1515
```bash
1616
yarn bootstrap // it will run and install into the root all packages subfolders
1717
```
1818

19-
yarn bootstrap will use hoisting. What it mean for you ?
19+
`yarn bootstrap` will use hoisting. What does it mean for you ?
2020

2121
It will regroup all dependencies in the workspace root and link all packages.
2222

23-
to check the link you can run
23+
Check the link by running the following command:
2424

2525
```bash
2626
ls -la node_modules/@vuepress
@@ -45,17 +45,17 @@ run `yarn tsc` all the time or run in separate shell `yarn run tsc -w`. This wil
4545

4646
## Link
4747

48-
Good from here you have everything ready. You need to link vuepress to your project.
48+
Good from here you have everything ready. You need to link VuePress to your project.
4949

5050
```bash
5151
yarn register-vuepress
5252
```
5353

5454
You will have something like this: `success Registered "vuepress".`
5555

56-
It will link the package vuepress from packages/vuepress. So you will have access to vuepress cli and vuepress packages.
56+
It will link the package VuePress from `packages/vuepress`. You will have access to VuePress cli and packages.
5757

58-
they are decalre in the `packages/vuepress/package.json`
58+
They are declared in the `packages/vuepress/package.json`
5959

6060
```js
6161
{
@@ -87,10 +87,10 @@ If everything work properly you should have an error telling you there is no pac
8787
## BUGS / QA
8888

8989
You will maybe find some difficulty with link. If you encounter something like `There's already a package called "vuepress" registered`.
90-
You have already vuepress registered. so:
90+
You already have VuePress registered:
9191

92-
- if you already link vuepress from [Link](#link). It's totally fine. If you make changes because it is symlink you dont have to re run something. You will have to rerun yarn tsc if you update shared-utils package. Nothing more
93-
- if you have done nothing. You have already vuepress linked somewhere. What you have to do is to delete folder where you already run `yarn link` or run `yarn unlink` inside it.
92+
- If you already link VuePress from [Link](#link). It’s totally fine. If you make changes because it is symlink you dont have to re run something. You will have to rerun yarn tsc if you update shared-utils package. Nothing more
93+
- If you didn’t do anything. You already have VuePress linked somewhere. What you have to do is deleting folder where you ran `yarn link` or `yarn unlink`.
9494

9595
## More
9696

0 commit comments

Comments
 (0)