메인 컨텐츠로 이동

카나리 릴리스

도큐사우루스에 카나리(Canary) 릴리스 시스템을 도입했습니다.

It permits you to test new unreleased features as soon as the pull requests are merged.

새로 구현된 기능이 의도한 대로 동작하는지 확인해서 유지관리자에게 피드백을 줄 수 있는 멋진 방법입니다.

note

Using a canary release in production might seem risky, but in practice, it's not.

A canary release passes all automated tests and is used in production by the Docusaurus site itself.

caution

The canary version shown below may not be up-to-date. Please go to the npm page to find the actual version name.

카나리 npm 배포 태그

For any code-related commit on main, the continuous integration will publish a canary release under the @canary npm dist tag. It generally takes up to 10 minutes.

You can see on npm the current dist tags:

  • latest: stable releases (Current: 2.0.0-beta.19)
  • canary: canary releases (Example: 0.0.0-4922)
tip

Make sure to use the latest canary release and check the publication date (sometimes the publish process fails).

note

Canary versions follow the naming convention 0.0.0-commitNumber.

카나리 릴리스 사용하기

Take the latest version published under the canary npm dist tag (Example: 0.0.0-4922).

Use it for all the @docusaurus/* dependencies in your package.json:

-  "@docusaurus/core": "^2.0.0-beta.19",
- "@docusaurus/preset-classic": "^2.0.0-beta.19",
+ "@docusaurus/core": "0.0.0-4922",
+ "@docusaurus/preset-classic": "0.0.0-4922",

Then, install the dependencies again and start your site:

npm install
npm start

You can also upgrade the @docusaurus/* packages with command line:

npm install --save-exact @docusaurus/core@canary @docusaurus/preset-classic@canary
caution

Make sure to include all the @docusaurus/* packages.

For canary releases, prefer using an exact version instead of a semver range (avoid the ^ prefix).