메인 컨텐츠로 이동

카나리 릴리스

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

풀 리퀘스트가 다음 버전의 도큐사우루스에 머지되는 즉시 출시되지 않는 새로운 기능을 테스트할 수 있습니다.

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

참고

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

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

경고

아래 표시된 카나리 버전은 최신 버전이 아닐 수 있습니다. 실제 버전명을 찾으려면 npm page를 확인하세요.

카나리 npm 배포 태그​

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

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

  • latest: 안정된 릴리스 (Current: 3.6.1)
  • canary: 카나리 릴리스 (예시: 0.0.0-4922)
팁

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

참고

카나리 버전은 다음과 같은 명명 규칙을 사용합니다. 0.0.0-commitNumber.

카나리 릴리스 사용하기​

canary npm 배포 태그(예시: 0.0.0-4922)로 게시된 최신 버전을 가져옵니다.

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

-  "@docusaurus/core": "^3.6.1",
-  "@docusaurus/preset-classic": "^3.6.1",
+  "@docusaurus/core": "0.0.0-4922",
+  "@docusaurus/preset-classic": "0.0.0-4922",

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

npm install
npm start

@docusaurus/* 패키지는 아래 명령으로 업그레이드할 수도 있습니다.

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

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

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