v2.0.0

[love1ace]

Summary by CodeRabbit

• 신규 기능

  • AI를 활용한 Git 커밋 메시지 자동 생성 도구 byul 추가.
  • Node.js 패키지를 npm에 자동 배포하는 GitHub Actions 워크플로우 추가.
  • 커밋 메시지 포맷팅 기능 개선 및 비동기 작업으로 구조화.

• 버그 수정

  • 커밋 메시지 포맷팅 관련 오류 수정 및 사용자 피드백 개선.

• 문서화

  • README 파일 업데이트: AI 모드 활성화 및 비활성화 방법, 설정 오류 해결 방법 추가.
  • 새로운 README.ko.md 파일 추가: 한국어 사용자 가이드 제공.

• 구성 변경

  • byul.config.json 파일에 AI 기능 및 언어 설정 추가.
  • package.json 파일에 새로운 의존성 추가 및 버전 업데이트.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

이 변경 사항은 Git 커밋 메시지를 자동으로 생성하고 포맷하는 도구인 byul의 기능을 개선하는 데 중점을 두고 있습니다. 새로운 GitHub Actions 워크플로우가 도입되어 Node.js 패키지를 npm에 배포하고, 여러 파일에서 커밋 메시지 포맷팅과 관련된 기능이 추가 및 수정되었습니다. 또한, README 파일이 업데이트되어 사용자 가이드와 설정 정보가 강화되었습니다.

Changes

파일 경로	변경 요약
.github/.gitmessage.txt	커밋 메시지 템플릿 파일 삭제.
.github/workflows/deploy.yml	Node.js 패키지를 npm에 자동으로 배포하는 GitHub Actions 워크플로우 추가.
README.ko.md	byul 도구에 대한 설명 및 설치, 구성 방법 추가.
README.md	byul의 기능 및 설정 오류 해결 방법에 대한 업데이트.
byul.config.json	AI 모드 구성, 언어 및 모델 선택을 위한 새로운 설정 추가.
byulhook.yml	commit-msg 명령의 스크립트 경로 수정.
package.json	버전 업데이트 및 새로운 의존성 추가, 스크립트 수정.
src/index.ts	커밋 메시지 포맷팅 기능 재구성 및 OpenAI API 통합.
src/isValidNumber.ts	유효한 숫자를 확인하는 isValidNumber 함수 추가.
src/legacyFormatCommitMessage.ts	커밋 메시지를 포맷하는 legacyFormatCommitMessage 함수 추가.

Possibly related PRs

• [fix] BYUL 1.3.1 causes BYUL to work even when SQUASH or AMEND is present #54: byul.config.json 파일 수정 및 커밋 메시지 포맷팅과 관련된 commit-msg 훅의 기능 논의.
• [fix] byul v1.4에서 git commit일 때 byul 포맷팅이 되지 않는 오류를 해결 #58: src/index.ts의 formatCommitMessage 함수에서 버그 수정, 커밋 메시지 포맷팅과 관련된 변경 사항.

Suggested labels

release

Suggested reviewers

• nakyeonko3

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.