mirror of
https://github.com/facebook/docusaurus.git
synced 2025-05-21 21:16:59 +02:00
43 lines
1.9 KiB
Markdown
43 lines
1.9 KiB
Markdown
Docusaurus is published as an npm package that can be installed via `npm` or `yarn`. Here is how you publish the package to npm:
|
|
|
|
## Log in to npm
|
|
|
|
Publishing will only work if you are logged into npm with an account with admin rights to the package.
|
|
|
|
If you are not currently logged into npm locally:
|
|
|
|
1. `npm adduser`
|
|
1. Enter username, password and associated email address
|
|
|
|
## Publish
|
|
|
|
1. Bump version number in [`package.json`](https://github.com/facebook/docusaurus/blob/master/package.json).
|
|
1. Update the [changelog](https://github.com/facebook/docusaurus/blob/master/CHANGELOG.md), including at the reference links at the bottom.
|
|
1. Do this always, but particularly important if there were any `package.json` changes in this release:
|
|
1. If there is no `node_modules` directory in you local Docusaurus version, run `yarn install` and `npm install`.
|
|
1. Run `yarn upgrade` to update `yarn.lock` and `npm update` to update `package-lock.json`.
|
|
1. From the `website-1.x` directory, run `npm run docusaurus-version x.x.x`, where x.x.x is the same version number you updated to in `package.json`.
|
|
1. Test your PR locally on a project that was created via [these instructions](https://github.com/facebook/docusaurus/blob/master/admin/local-third-party-project-testing.md).
|
|
1. Submit your PR
|
|
1. When your PR is merged, rebase to get the PR commit locally.
|
|
1. Run `npm publish`
|
|
|
|
### What version should you use?
|
|
|
|
The version number should generally increase by some factor than the current one. You can check current version by looking in `package.json`.
|
|
|
|
```json
|
|
{
|
|
"name": "docusaurus",
|
|
"version": "1.0.0-alpha.41",
|
|
"repository": {
|
|
"type": "git",
|
|
"url": "https://github.com/facebook/docusaurus.git"
|
|
}
|
|
...
|
|
}
|
|
```
|
|
|
|
For the above example, you may want to bump the version to `1.0.0-alpha.42` or `1.0.0-beta.1` or `1.0.1`.
|
|
|
|
You can also see the full list of all published versions with `npm show docusaurus versions --json`.
|