메인 컨텐츠로 이동

카나리 릴리스

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

이제 여러분은 풀 리퀘스트가 병합되자마자 공개되지 않은 새로운 기능을 확인해볼 수 있습니다.

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

note

카나리 릴리스를 운영중인 사이트에 반영하는 것은 위험해보이지만 실제로는 그렇지 않습니다.

카나리 릴리스는 모든 자동화 테스트를 통과했으며 현재 운영중인 도큐사우루스 사이트에 먼저 반영해서 사용하고 있는 기능입니다.

카나리 npm 배포 태그#

master에 커밋되는 코드 관련 건은 CI를 통해 @canary npm 배포 태그를 달고 카나리 릴리스로 배포됩니다. 이 작업은 대략 10분 정도 걸립니다.

npm에서 현재 배포 태그를 확인할 수 있습니다.

  • latest: stable releases (예: 2.0.0-beta.0)
  • canary: canary releases (example: 0.0.0-1234+4a6de5cf7)
tip

카나리 릴리스가 최신인지 확인하려면 게시 일자를 확인하세요(간혹 배포 프로세스가 실패하기도 합니다).

note

Canary versions follow the naming convention 0.0.0-commitNumber+commitHash.

카나리 릴리스 사용하기#

Take the latest version published under the canary npm dist tag (for example: 0.0.0-1234+4a6de5cf7).

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

-  "@docusaurus/core": "^2.0.0-beta.0",-  "@docusaurus/preset-classic": "^2.0.0-beta.0",+  "@docusaurus/core": "0.0.0-1234+4a6de5cf7",+  "@docusaurus/preset-classic": "0.0.0-1234+4a6de5cf7",

Then, install the dependencies again and start your site:

npm installnpm start

You can also upgrade the @docusaurus/* packages with a 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).