@mintlify/cli 3.0.70 → 3.0.71

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.
Files changed (2) hide show
  1. package/CONTRIBUTING.md +15 -18
  2. package/package.json +4 -4
package/CONTRIBUTING.md CHANGED
@@ -20,26 +20,23 @@ Here's how to publish new client changes to the CLI:
20
20
 
21
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
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.
23
+ 3. Create PR, copy/pasting the following test plan:
24
+
25
+ ```
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
+ - [ ] confirm new CLI behavior is observed
34
+ ```
35
+
36
+ 4. Start a new `Upload zip` workflow. **BE SURE TO SPECIFY YOUR PR BRANCH** and the new client version number.
24
37
  <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
41
38
  5. Execute test plan.
42
39
  6. Merge PR.
43
40
  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`.
44
- 8. For completeness, download the zip from bunny.net and create a new GitHub release with the given version.
41
+ 8. Lastly, download the zip from bunny.net and create a new GitHub release with the given version. Click on `Generate release notes` to auto-populate the description.
45
42
  <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,6 +1,6 @@
1
1
  {
2
2
  "name": "@mintlify/cli",
3
- "version": "3.0.70",
3
+ "version": "3.0.71",
4
4
  "description": "The Mintlify CLI",
5
5
  "engines": {
6
6
  "node": ">=18.0.0"
@@ -48,8 +48,8 @@
48
48
  ]
49
49
  },
50
50
  "dependencies": {
51
- "@mintlify/link-rot": "3.0.14",
52
- "@mintlify/previewing": "3.1.67",
51
+ "@mintlify/link-rot": "3.0.15",
52
+ "@mintlify/previewing": "3.1.68",
53
53
  "@mintlify/validation": "0.1.52",
54
54
  "chalk": "^5.2.0",
55
55
  "detect-port": "^1.5.1",
@@ -82,5 +82,5 @@
82
82
  "ts-jest-resolver": "^2.0.1",
83
83
  "typescript": "^4.9.5"
84
84
  },
85
- "gitHead": "bafbca56179d3bd1d683e9f348082e48d91f005f"
85
+ "gitHead": "5790e1751d482b1bf041b1942b5c9d4c43708115"
86
86
  }