메인 컨텐츠로 이동

카나리 릴리스

도큐사우루스에 카나리(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.

카나리 npm 배포 태그

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

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

  • latest: stable releases (example: 2.0.0-beta.9)
  • canary: canary releases (example: 0.0.0-4222)
tip

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

note

Canary versions follow the naming convention 0.0.0-commitNumber.

카나리 릴리스 사용하기

Take the latest version published under the canary npm dist tag (for example: 0.0.0-4222).

package.json에서 @docusaurus/*로 시작하는 종속성을 체크해주세요.

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

종속적인 모듈을 설치한 후 사이트를 시작합니다.

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

모든 @docusaurus/* 패키지가 작업에 포함되어야 합니다.

카나리 릴리스는 시맨틱 버전 관리 대신 정확한 버전을 사용하는 것이 좋습니다(^ 접두사를 사용하지 않습니다).