Semantic Release Notes Parser

명령줄 인터페이스

이 도구는 SemanticReleaseNotes [parameters] 형식으로 실행되며, 모든 매개변수는 선택 사항입니다. 기본적으로 현재 디렉터리의 ReleaseNotes.md 파일을 파싱하여 ReleaseNotes.html 파일을 생성합니다.

출력 형식 및 유형 선택

• -f=<html|markdown>: 출력 파일의 형식을 HTML 또는 마크다운 중 하나로 지정합니다. 기본값은 HTML입니다.
• -t=<file|environment|fileandenvironment>: 출력 유형을 지정합니다. file는 파일을 생성하고, environment는 SemanticReleaseNotes 이름의 환경 변수를 설정하며, fileandenvironment는 둘 다 수행합니다.

파일 경로 지정

• -r=<filename>: 파싱할 릴리스 노트 파일 경로를 지정합니다. 기본값은 ReleaseNotes.md입니다.
• -o=<filename>: 결과 파일의 경로를 지정합니다. 기본값은 ReleaseNotes.html 또는 -t 옵션에 따라 결정됩니다.

그룹화 및 템플릿 기능

• -g=<sections|categories>: 항목을 섹션 또는 카테고리 기준으로 그룹화합니다. 기본값은 sections입니다.
• --template: Liquid 템플릿 파일의 경로를 지정하여 출력 형식을 커스터마이징합니다. 이 옵션은 -t, -f, -g 설정을 덮어씁니다.
• --pluralizecategoriestitle: g=categories 사용 시 카테고리 제목을 복수형으로 변경합니다.
• --includestyle[=<custom style>]: HTML 출력에 스타일을 포함합니다. 사용자 지정 스타일이 없으면 기본 스타일이 적용됩니다.
• --debug: 디버그 메시지를 출력하여 문제 해결을 돕습니다.
• -h: 도움말 메시지를 표시합니다.

다운로드·설치 방법

이 도구는 세 가지 방식으로 설치할 수 있습니다.

• Chocolatey를 통해 설치: choco install semanticreleasenotesparser 명령어를 실행합니다.
• NuGet을 통해 핵심 라이브러리 설치: Install-Package SemanticReleaseNotesParser.Core 명령어를 사용합니다.
• 수동 설치: GitHub 저장소의 Releases 페이지에서 ZIP 파일을 다운로드하고 압축을 해제한 후 실행 파일을 사용합니다.

기본 사용법/명령어

설치 후 명령 프롬프트 또는 PowerShell에서 다음 명령어를 사용하여 기본 동작을 확인할 수 있습니다.

• 기본 사용법: 현재 디렉터리의 ReleaseNotes.md를 파싱하여 ReleaseNotes.html 생성
  SemanticReleaseNotes
• 사용자 지정 입력 및 출력 파일 지정:
  SemanticReleaseNotes -r=MyNotes.txt -o=Output.html
• 환경 변수로 출력 (빌드 서버용):
  SemanticReleaseNotes -t=environment
  이 명령은 SemanticReleaseNotes 환경 변수를 설정하여 파싱 결과를 전달합니다.
• HTML 출력에 기본 스타일 포함:
  SemanticReleaseNotes --includestyle
• 도움말 보기:
  SemanticReleaseNotes -h

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

이 도구는 Windows에서 실행 가능한 바이너리로 배포되며, .NET 프레임워크 또는 .NET 런타임이 필요합니다. 정확한 버전 요구사항은 공식 배포 페이지에서 확인할 수 있습니다.

최신 버전·업데이트

현재 버전은 0.1.0이며, 최신 소스 코드와 릴리스 정보는 GitHub 저장소에서 확인할 수 있습니다. 업데이트는 GitHub의 Releases 섹션을 통해 제공됩니다.