@mintlify/cli 3.0.62 → 3.0.63
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CONTRIBUTING.md +20 -5
- package/package.json +6 -11
package/CONTRIBUTING.md
CHANGED
|
@@ -18,13 +18,28 @@ The CLI uses GitHub releases to download specific versions of the client code us
|
|
|
18
18
|
|
|
19
19
|
Here's how to publish new client changes to the CLI:
|
|
20
20
|
|
|
21
|
-
1.
|
|
22
|
-
2.
|
|
23
|
-
3.
|
|
24
|
-
4. Start a new `Upload zip` workflow. **BE SURE TO SPECIFY YOUR PR BRANCH** and the new client version number.
|
|
21
|
+
1. In `mint/packages/mintlify-previewing/src/constants.ts`, update the value of `TARGET_MINT_VERSION` to match the current version of the client package (`mint/client/package.json`). ([example PR](https://github.com/mintlify/mint/pull/770/files#diff-d8424b340a10b1927bea6b52668d2d83dd49e0c563dde8716274a639edac8a9f), but you should only need to change `constants.ts`)
|
|
22
|
+
2. Commit change and push branch to github.
|
|
23
|
+
3. Start a new `Upload zip` workflow. **BE SURE TO SPECIFY YOUR PR BRANCH** and the new client version number.
|
|
25
24
|
<img width="800" alt="Screenshot 2023-04-24 at 10 03 15 PM" src="https://user-images.githubusercontent.com/63772591/234178961-ab33c765-8b42-41e8-942f-f0a929d7abbf.png">
|
|
25
|
+
4. Create PR, copy/pasting the following test plan:
|
|
26
|
+
- [] uninstall global mintlify with `npm uninstall -g mintlify`
|
|
27
|
+
- [] `cd` to `mint/packages/mintlify` and link with `npm link`
|
|
28
|
+
- [] build from `mint` folder with `yarn build`
|
|
29
|
+
- [] clear out any existing downloaded zip with `rm -rf ~/.mintlify`
|
|
30
|
+
- [] `cd` to a docs folder
|
|
31
|
+
- [] run `mintlify dev`
|
|
32
|
+
- [] verify new client version is reflected in output
|
|
33
|
+
```
|
|
34
|
+
$ mintlify dev
|
|
35
|
+
✔ Local Mintlify instance is ready. Launching your site...
|
|
36
|
+
|
|
37
|
+
> @mintlify/client@0.0.61 dev-watch
|
|
38
|
+
> next-remote-watch ./src/_props ./public
|
|
39
|
+
```
|
|
40
|
+
- [] confirm new CLI behavior is observed
|
|
26
41
|
5. Execute test plan.
|
|
27
42
|
6. Merge PR.
|
|
28
|
-
7. Wait for `Bump packages` workflow to succeed on your squashed commit. At this point, all npm packages have been updated
|
|
43
|
+
7. Wait for `Bump packages` workflow to succeed on your squashed commit. At this point, all npm packages have been updated, and you can use the new version by running `npm update -g mintlify`.
|
|
29
44
|
8. For completeness, download the zip from bunny.net and create a new GitHub release with the given version.
|
|
30
45
|
<img width="800" alt="Screenshot 2023-04-24 at 10 10 26 PM" src="https://user-images.githubusercontent.com/63772591/234179953-9d0976db-9a3b-4678-b844-245b95385671.png">
|
package/package.json
CHANGED
|
@@ -1,18 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mintlify/cli",
|
|
3
|
-
"version": "3.0.
|
|
3
|
+
"version": "3.0.63",
|
|
4
4
|
"description": "The Mintlify CLI",
|
|
5
5
|
"engines": {
|
|
6
6
|
"node": ">=18.0.0"
|
|
7
7
|
},
|
|
8
8
|
"author": "Mintlify, Inc.",
|
|
9
|
-
"repository": {
|
|
10
|
-
"type": "git",
|
|
11
|
-
"url": "https://github.com/mintlify/mint",
|
|
12
|
-
"directory": "packages/mintlify-cli"
|
|
13
|
-
},
|
|
14
9
|
"bugs": {
|
|
15
|
-
"url": "https://github.com/mintlify/
|
|
10
|
+
"url": "https://github.com/mintlify/docs/issues"
|
|
16
11
|
},
|
|
17
12
|
"license": "Elastic-2.0",
|
|
18
13
|
"keywords": [
|
|
@@ -53,9 +48,9 @@
|
|
|
53
48
|
]
|
|
54
49
|
},
|
|
55
50
|
"dependencies": {
|
|
56
|
-
"@mintlify/link-rot": "3.0.
|
|
57
|
-
"@mintlify/previewing": "3.1.
|
|
58
|
-
"@mintlify/validation": "0.1.
|
|
51
|
+
"@mintlify/link-rot": "3.0.9",
|
|
52
|
+
"@mintlify/previewing": "3.1.62",
|
|
53
|
+
"@mintlify/validation": "0.1.49",
|
|
59
54
|
"chalk": "^5.2.0",
|
|
60
55
|
"detect-port": "^1.5.1",
|
|
61
56
|
"inquirer": "^9.2.7",
|
|
@@ -87,5 +82,5 @@
|
|
|
87
82
|
"ts-jest-resolver": "^2.0.1",
|
|
88
83
|
"typescript": "^4.9.5"
|
|
89
84
|
},
|
|
90
|
-
"gitHead": "
|
|
85
|
+
"gitHead": "d470561e9abd9ef22eb1a275e121bd4940ffd2ad"
|
|
91
86
|
}
|