Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(v1): release docusaurus v1.14.7 #4372

Merged
merged 10 commits into from Mar 9, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 12 additions & 0 deletions CHANGELOG.md
Expand Up @@ -4,6 +4,18 @@ All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [1.14.7] - 2021-03-09

#### :house: Internal

- `docusaurus-1.x`

- [#4270](https://github.com/facebook/docusaurus/pull/4270) chore: upgrade react-dev-utils ([@yangshun](https://github.com/yangshun))

#### Committers: 1

- Yangshun Tay ([@yangshun](https://github.com/yangshun))

## [1.14.6] - 2020-08-05

#### :bug: Bug Fix
Expand Down
14 changes: 11 additions & 3 deletions admin/publish.md
Expand Up @@ -243,7 +243,13 @@ https://github.com/facebook/docusaurus/releases/tag/%VER%

**TLDR**: you need to mark them as public, publish, and mark them back as private

v1 packages have been marked as `private: true` on purpose. This is because lerna will publish ALL (v1+v2) packages with the lerna-publish command. Unfortunately it seems therre is no way to tell it to ignore v1 packages while publishing v2. During a long time, we published all these packages using the @next dist tag: `yarn lerna publish 2.0.0-alpha.41 --dist-tag next --exact` But it cause problems because v2 packages will then all need @next during npm/yarn installs, confusing some users (https://github.com/facebook/docusaurus/issues/3755) We made the v1 packages private so that lerna publish won't publish them, so that we can publish v2 packages under latest dist tag, without creating v1 upgrades that people will be notified abut.
v1 packages have been marked as `private: true` on purpose. This is because lerna will publish ALL (v1+v2) packages with the lerna-publish command.

Unfortunately it seems there is no way to tell it to ignore v1 packages while publishing v2.

During a long time, we published all these packages using the `@next` dist tag: `yarn lerna publish 2.0.0-alpha.41 --dist-tag next --exact`. It caused problems because v2 packages will then all need @next during npm/yarn installs, confusing some users (https://github.com/facebook/docusaurus/issues/3755).

We made the v1 packages private so that lerna publish won't publish them, so that we can publish v2 packages under latest dist tag, without creating v1 upgrades that people will be notified abut.

### Updated v1 release process

Expand All @@ -259,8 +265,9 @@ Suppose we are at `v1.14.5`, and want to release `v1.14.6`:
- Run `yarn install`
- Version the docs: `yarn workspace docusaurus-1-website docusaurus-version 1.14.6`
- Test the v1 website locally: `yarn start:v1` + `yarn build:v1`
- Make the v1 package private: false
- Publish: `yarn workspace docusaurus publish --new-version 1.14.6`
- Make the two v1 packages private: false
- Publish: `yarn workspace docusaurus-init publish --no-git-tag-version --new-version 1.14.6`
- Publish: `yarn workspace docusaurus publish --no-git-tag-version --new-version 1.14.6`
- Make the v1 package private: true

The release is now published. It's worth to test it by initializing a new v1 site:
Expand All @@ -279,6 +286,7 @@ Finish the release:
- Push: `git push origin slorber/release-1.14.6`
- Run `git tag v1.14.6` (important: the tag is prefixed by **`v`**)
- Run `git push origin v1.14.6`
- Ensure you can run `yarn install` (it may fail and need to use v2 versions on the v1 packages...)
- Open a PR, and merge it
- Create the [new Github release](https://github.com/facebook/docusaurus/releases/new), paste the changelog
- The End
Expand Down