bicep-docs

문서 자동 생성

Bicep 파일이나 디렉토리를 입력하면 해당 템플릿의 구조를 분석하여 마크다운 형식의 문서를 자동으로 생성합니다. 디렉토리를 지정하면 각 하위 디렉토리의 main.bicep 파일에 대해 README.md 파일을 재귀적으로 생성합니다.

맞춤형 섹션 포함

–include-sections 및 –exclude-sections 인수를 사용하여 생성할 문서의 섹션을 선택할 수 있습니다. 기본적으로 description, usage, modules, resources, parameters, udfs,uddts, variables, outputs 섹션이 포함됩니다.

상세 정보 표시

–show-all-decorators 플래그를 사용하면 Bicep 데코레이터의 제약 조건 정보(허용 값, 최소/최대 제한, 내보내기 가능 상태 등)를 포함한 상세한 문서를 생성할 수 있습니다.

다운로드·설치 방법

Windows 사용자는 Chocolatey 패키지 매니저를 통해 간편하게 설치할 수 있습니다.

다음 명령어를 실행하면 bicep-docs가 설치됩니다:

choco install bicep-docs

기타 설치 방법으로는 Homebrew, Go install, 또는 GitHub 릴리스 페이지에서 최신 바이너리를 직접 다운로드할 수 있습니다.

기본 사용법

bicep-docs는 Bicep 파일 또는 디렉토리를 입력으로 받아 마크다운 문서를 생성합니다.

기본 사용법은 다음과 같습니다:

• Bicep 파일을 지정하여 문서 생성: bicep-docs –input main.bicep –output readme.md
• 현재 디렉토리에 README.md 파일 생성: bicep-docs -i main.bicep
• 디렉토리 내 모든 main.bicep 파일에 대한 문서 생성: bicep-docs -i ./bicep -V

기본 출력 파일은 현재 작업 디렉토리에 생성되는 README.md입니다. 이미 파일이 존재하면 덮어씁니다.

이런 경우에 유용합니다

• Azure 인프라 코드 프로젝트의 Bicep 템플릿 문서를 자동으로 생성하고 유지보수해야 할 때
• 여러 개의 Bicep 모듈로 구성된 대규모 프로젝트의 표준화된 문서가 필요할 때
• 팀 내에서 Bicep 템플릿의 구조와 매개변수를 명확하게 공유해야 할 때
• 지속적 통합/지속적 배포(CI/CD) 파이프라인에서 문서 자동화가 필요할 때

지원 환경·시스템 요구사항

bicep-docs는 Go로 작성되어 Windows, macOS, Linux에서 모두 사용 가능합니다. Azure CLI 버전 2.77.0 이상 또는 Bicep CLI 버전 0.38.3 이상이 필요합니다.

최신 버전·업데이트

현재 제공된 증거에 따르면 버전 1.8.0이 Chocolatey 패키지로 등록되어 있습니다. 최신 릴리스 정보는 GitHub 릴리스 페이지에서 확인할 수 있습니다.

제한 사항·확인 사항

• Azure CLI 또는 Bicep CLI가 반드시 설치되어 있어야 합니다.
• 이미 존재하는 마크다운 파일은 덮어쓰여지므로 주의가 필요합니다.
• –include-sections와 –exclude-sections 인수는 동시에 사용할 수 없습니다.