Skip to content

Commit 4ca2299

Browse files
authored
Update publishing docs (#1914)
1 parent dcbf334 commit 4ca2299

File tree

3 files changed

+17
-27
lines changed

3 files changed

+17
-27
lines changed

.github/workflows/publish.yml

Lines changed: 0 additions & 22 deletions
This file was deleted.

docs/community/contribute.server.mdx

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -97,9 +97,23 @@ This produces the website in `public/`.
9797

9898
To release a new version, do:
9999

100-
* Draft a release for the next version (vX.X.X)
101-
* `yarn && yarn test && yarn lerna publish --force-publish`
102-
* Publish release on GitHub
100+
1. update `version`s of packages with a patch, minor, or major (make sure to
101+
update dependency ranges on monorepo packages when needed):
102+
```sh
103+
npm version minor --workspaces --no-git-tag-version
104+
```
105+
2. commit and tag using the version (without `v`) as the message:
106+
```sh
107+
git commit --all --message 1.2.3 && git tag 1.2.3 && git push && git push --tags
108+
```
109+
3. release to the npm registry:
110+
```sh
111+
npm publish --workspaces
112+
```
113+
4. add a changelog entry for the release on GitHub:
114+
```sh
115+
open https://github.com/mdx-js/mdx/releases
116+
```
103117

104118
## Resources
105119

package.json

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -131,8 +131,6 @@
131131
"docs-deploy": "vercel && vercel alias $(pbpaste) mdxjs.com && vercel alias $(pbpaste) www.mdxjs.com",
132132
"format": "remark . -qfo && remark . -e mdx -u mdx -qfo && prettier . -w --loglevel warn && xo --fix",
133133
"lint": "remark . -qf && remark . -e mdx -u mdx -qf && prettier . -c --loglevel warn && xo",
134-
"publish-ci": "# lerna publish -y --canary --preid ci --pre-dist-tag ci",
135-
"publish-next": "# lerna publish --force-publish=\"*\" --pre-dist-tag next --preid next",
136134
"build": "npm run build --workspaces --if-present",
137135
"test-api": "npm run test-api --workspaces --if-present",
138136
"test-coverage": "npm run test-coverage --workspaces --if-present",

0 commit comments

Comments
 (0)