diff --git a/admin/publish.md b/admin/publish.md index 617a8b669d..5f26bac1f6 100644 --- a/admin/publish.md +++ b/admin/publish.md @@ -38,6 +38,8 @@ If there are no errors, you can start preparing for the new release. Generate a GitHub auth token by going to https://github.com/settings/tokens. Save the token somewhere for future reference. +> Before running the command below, get all tags from the original repository by runnung `git fetch --tags`. + ```sh GITHUB_AUTH= yarn changelog ``` @@ -61,6 +63,42 @@ Make a commit and create a pull request with the changes and get it merged. An e As we have a monorepo structure, we use `lerna publish` to publish the new version of packages to npm in one shot. +First, be sure to run the command below to verify that you have access to all the necessary repositories. + +```sh +npm access ls-packages +``` + +
+ The list of packages which need access (as of April 2020) +
+{
+  "@docusaurus/plugin-sitemap": "read-write",
+  "@docusaurus/mdx-loader": "read-write",
+  "@docusaurus/utils": "read-write",
+  "@docusaurus/core": "read-write",
+  "@docusaurus/plugin-content-blog": "read-write",
+  "@docusaurus/plugin-content-docs": "read-write",
+  "@docusaurus/plugin-content-pages": "read-write",
+  "@docusaurus/preset-classic": "read-write",
+  "@docusaurus/theme-search-algolia": "read-write",
+  "@docusaurus/theme-classic": "read-write",
+  "@docusaurus/theme-live-codeblock": "read-write",
+  "@docusaurus/plugin-google-analytics": "read-write",
+  "@docusaurus/plugin-google-gtag": "read-write",
+  "@docusaurus/init": "read-write",
+  "@docusaurus/plugin-content-docs-legacy": "read-write",
+  "@docusaurus/plugin-ideal-image": "read-write",
+  "@docusaurus/types": "read-write",
+  "docusaurus": "read-write",
+  "docusaurus-init": "read-write",
+  "stylelint-copyright": "read-write"
+}
+
+
+ +If all accesses are available, you can run the command to release a new version: + ```sh yarn lerna publish 2.0.0-alpha.41 --dist-tag next ``` @@ -83,6 +121,39 @@ You should receive many emails notifying you that a new version of the packages - Hit the green "Publish release" button - Profit! 💰 +### 6. Notify people about new release (optional but desirable) + +After new release, it was cool to notify our users about this in the Dicsord chat (`docusaurus-users` channel) and write summaries in Twiiter using the following templates. + +For Discord: + +``` +A new version %VER% is available now! 🎉 +See release notes at the following link https://github.com/facebook/docusaurus/releases/tag/%VER% +``` + +For Twitter: + +``` +💥 A new version %VER% is available now! 💥 + +### +LIST HERE MAJOR FEATURES, SEE EXAMPLES BELOW + +- Dropdown nav 🔗 +- New code blocks features 🖥️ +- Draft blog posts ✏️ +- Announcement bar 📢 + +.. + +NOTE: most likely this last item will be relevant for each new release, so do not forget include it +- Many documentation improvements and bug fixes! 🐛 +### + +https://github.com/facebook/docusaurus/releases/tag/%VER% +``` + ## Docusaurus 1 1. Bump version number in [`package.json`](https://github.com/facebook/docusaurus/blob/master/package.json).