diff --git a/CHANGELOG.md b/CHANGELOG.md index eed7b10409..88d47487a8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,22 @@ 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.6] - 2020-08-05 + +#### :bug: Bug Fix + +- `docusaurus-1.x` + + - [#3213](https://github.com/facebook/docusaurus/pull/3213) fix(v1): fresh install failing due to <> syntax ([@slorber](https://github.com/slorber)) + +#### :memo: Documentation + +- [#3186](https://github.com/facebook/docusaurus/pull/3186) docs(v1): formatting changelog ([@slorber](https://github.com/slorber)) + +#### Committers: 1 + +- Sébastien Lorber ([@slorber](https://github.com/slorber)) + ## [1.14.5] - 2020-08-01 #### :rocket: New Feature diff --git a/admin/publish.md b/admin/publish.md index 037408f676..0eb3f67229 100644 --- a/admin/publish.md +++ b/admin/publish.md @@ -89,7 +89,13 @@ GITHUB_AUTH= yarn changelog Copy the generated contents and paste them in `CHANGELOG-2.x.md`. -**Note**: sometimes `lerna-changelog` gives an empty changelog ([bug report](https://github.com/lerna/lerna-changelog/issues/354)). Adding the `--from` options seems to help (`yarn changelog --from v2.0.0-alpha.60`). +**Note**: sometimes `lerna-changelog` gives an empty changelog ([bug report](https://github.com/lerna/lerna-changelog/issues/354)). + +Adding the `--from` options seems to help: + +```sh +yarn changelog --from v2.0.0-alpha.60` +``` ### 4. Cut a new version of the docs @@ -223,7 +229,45 @@ 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). +### Updated v1 release process + +Process reworked by @slorber at `1.14.6`, it may not be perfect yet: + +Suppose we are at `v1.14.5`, and want to release `v1.14.6`: + +- Assign appropriate `tag: xyz` labels to merged PRs +- Be on master (up-to-date): `git co master && git pull` +- Create a new branch: `git co -b slorber/release-1.14.6` +- Get the changelog from last release: `git fetch --tags && GITHUB_AUTH= yarn changelog --from=v1.14.5` +- Update [CHANGELOG.md](https://github.com/facebook/docusaurus/blob/master/CHANGELOG.md), but remove the v2-related items manually. +- 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` +- Publish: `yarn workspace docusaurus publish --new-version 1.14.6` + +The release is now published. It's worth to test it by initializing a new v1 site: + +```sh +mkdir my-v1-website +cd my-v1-website +npx docusaurus-init +cd website +yarn start +``` + +Finish the release: + +- Commit: `git commit -am "chore(v1): release v1.14.6"` +- 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` +- Open a PR, and merge it +- Create the [new Github release](https://github.com/facebook/docusaurus/releases/new), paste the changelog +- The End + +### Historical v1 release process + +1. Bump version number in [`package.json`](https://github.com/facebook/docusaurus/blob/master/packages/docusaurus-1.x/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`. diff --git a/packages/docusaurus-1.x/package.json b/packages/docusaurus-1.x/package.json index 2d7c76eb3f..cc96c8aff9 100644 --- a/packages/docusaurus-1.x/package.json +++ b/packages/docusaurus-1.x/package.json @@ -1,7 +1,7 @@ { "name": "docusaurus", "description": "Easy to Maintain Open Source Documentation Websites", - "version": "1.14.5", + "version": "1.14.6", "license": "MIT", "keywords": [ "documentation", diff --git a/website-1.x/versions.json b/website-1.x/versions.json index 2e51a4645f..13e740aaf1 100644 --- a/website-1.x/versions.json +++ b/website-1.x/versions.json @@ -1,4 +1,5 @@ [ + "1.14.6", "1.14.5", "1.14.4", "1.13.0",