@mintlify/cli 3.0.25 → 3.0.26

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 +10 -3
  2. package/package.json +3 -3
package/CONTRIBUTING.md CHANGED
@@ -18,6 +18,13 @@ 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. Publish a new GitHub release. You can click the releases menu at the right of the repo page. Make the release title the same as the new release tag. Optionally, you can also use the description to keep track of what changed in that release.
22
- 2. Set `TARGET_MINT_VERSION` in `packages/mintlify-previewing/src/constants.ts` to to the new release tag.
23
- 3. Publish a new CLI version to npm.
21
+ 1. Bump the version of the client package, as well as the value of `TARGET_MINT_VERSION`. ([example PR](https://github.com/mintlify/old-mint/pull/567/files))
22
+ 2. If the version in `packages/mintlify-prebuild/package.json` is ahead of the version in `dependencies` of `client/package.json`, update the dependency and run `yarn` from the root folder. ([example PR](https://github.com/mintlify/old-mint/pull/553/files))
23
+ 3. Create PR, copy/pasting test plan from above PRs.
24
+ 4. Start a new `Upload zip` workflow. **BE SURE TO SPECIFY YOUR PR BRANCH** and the new client version number.
25
+ <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">
26
+ 5. Execute test plan.
27
+ 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.
29
+ 8. For completeness, download the zip from bunny.net and create a new GitHub release with the given version.
30
+ <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.25",
3
+ "version": "3.0.26",
4
4
  "description": "The Mintlify CLI",
5
5
  "engines": {
6
6
  "node": ">=18.0.0"
@@ -46,7 +46,7 @@
46
46
  },
47
47
  "dependencies": {
48
48
  "@apidevtools/swagger-parser": "^10.1.0",
49
- "@mintlify/previewing": "^3.1.21",
49
+ "@mintlify/previewing": "3.1.22",
50
50
  "@octokit/rest": "^19.0.5",
51
51
  "axios": "^1.2.2",
52
52
  "chalk": "^5.1.0",
@@ -98,5 +98,5 @@
98
98
  "ts-jest": "^29.0.5",
99
99
  "typescript": "^4.9.5"
100
100
  },
101
- "gitHead": "0d881cf8b1559b07ad11694885109b634075f813"
101
+ "gitHead": "c993563466ea4b2566661a4a9d275c8614915bba"
102
102
  }