mirror of https://github.com/asyouplz/SpeechNote.git synced 2026-07-22 16:30:31 +00:00

feat: implement semantic-release automation (#54 )

* feat: implement semantic-release automation

- Add semantic-release and required plugins
- Create .releaserc.json with Obsidian plugin configuration
- Add scripts/update-version.mjs for automated version updates
- Create release-auto.yml workflow for automated releases
- Update npm scripts with semantic-release commands
- Deprecate version-bump.mjs (will be removed after stabilization)
- Update .gitignore for semantic-release cache

This enables fully automated releases on PR merge to main:
- Analyzes commit messages (Conventional Commits)
- Determines version bump (major/minor/patch)
- Updates manifest.json, package.json, versions.json
- Generates CHANGELOG.md
- Creates GitHub release with assets

BREAKING CHANGE: Manual version updates via version-bump.mjs will be deprecated.
Use Conventional Commits format for all commits going forward.

* fix: address code review feedback from Claude bot

Addressing 8 issues identified in PR #54:
- [P0/Critical] Disable version-bump.yml to prevent workflow conflicts
- [P0/Critical] Remove persist-credentials: false from release-auto.yml
- [P0/Critical] Remove deprecated version lifecycle hook in package.json
- [P1/Important] Add semver and manifest validation to update-version.mjs
- [P1/Important] Fix JSON formatting consistency in scripts
- [P2/Optional] Enhance build artifact verification with file size checks
- [P2/Optional] Rename release.sh to release-emergency.sh and add warning

* fix: address final code review points and documentation updates

* fix: address third round of code review feedback

- Revert pre-commit hook to use lint-staged
- Add file existence checks to update-version.mjs
- Remove unnecessary npm override in package.json
- Add syntax verification for build artifacts in release workflow

* refactor: address pr #54 code review feedback

- add lint/typecheck/test steps to release-auto.yml workflow
- remove unnecessary token permissions (issues/pull-requests)
- add dry-run mode to update-version.mjs script
- strengthen commitlint rules (subject-case, max-length)
- improve git pull verification in emergency release script
- add RELEASING.md documentation with rollback procedures
- add unit tests for update-version.mjs script (7 tests)

* fix: address follow-up pr #54 review feedback

- remove continue-on-error from test step (P0)
- add package-lock.json to semantic-release git assets (P0)
- relax commitlint subject-case rule to allow sentence-case (P1)
- reuse update-version.mjs in emergency release script (P1)

* fix: add workflow skip protection and fix package-lock sync

- add if condition to prevent infinite loop from release commits
- add npm install --package-lock-only to prepareCmd for package-lock.json sync

* fix: address final pr review feedback

- add CHANGELOG.md bootstrap file for semantic-release (P0)
- split package-lock sync into separate exec plugin for correct timing (P0)
- add continue-on-error to test:ci temporarily (P1 - tests failing)

* fix: address must-fix review feedback

- remove test step from release workflow (tests unstable, fix in follow-up)
- restore husky hook initialization (shebang and husky.sh)

2026-01-26 11:25:25 +09:00

2.6 KiB

Raw Blame History

릴리스 가이드

SpeechNote 플러그인의 릴리스 프로세스 문서입니다.

자동 릴리스 (권장)

semantic-release를 사용하여 완전 자동화된 릴리스를 수행합니다.

사용 방법

Conventional Commits 형식으로 커밋합니다:

feat: add new transcription feature    # → Minor (3.1.0)
fix: resolve audio playback issue      # → Patch (3.0.1)
feat!: redesign settings UI            # → Major (4.0.0)

PR을 main 브랜치로 머지합니다.
GitHub Actions가 자동으로:
- 버전 업데이트
- CHANGELOG.md 생성
- GitHub Release 생성
- 빌드 아티팩트 업로드

Conventional Commits 가이드

타입	설명	버전 범프
`feat`	새로운 기능	Minor
`fix`	버그 수정	Patch
`perf`	성능 개선	Patch
`refactor`	코드 리팩토링	Patch
`docs`	문서 수정	-
`chore`	유지보수 작업	-

Breaking Change: 타입 뒤에 !를 붙이거나 커밋 본문에 BREAKING CHANGE: 포함 시 Major 버전 범프.

긴급 수동 릴리스

자동화 시스템이 작동하지 않을 때만 사용하세요.

./scripts/release-emergency.sh [patch|minor|major|VERSION]

예시

./scripts/release-emergency.sh patch    # 3.0.9 → 3.0.10
./scripts/release-emergency.sh 3.2.0    # 특정 버전 지정

롤백 절차

잘못된 릴리스 롤백

GitHub에서 릴리스 삭제:
- Releases 페이지에서 해당 릴리스 삭제

태그 삭제:

git tag -d v3.1.0
git push origin --delete v3.1.0

커밋 되돌리기 (필요시):
```
git revert HEAD
git push origin main
```

버전 파일만 롤백

git checkout HEAD~1 -- manifest.json package.json versions.json
git commit -m "fix: revert version files"
git push origin main

실패 처리

CI 파이프라인 실패

GitHub Actions 로그 확인
로컬에서 동일한 명령 실행하여 디버깅:
```
npm run lint
npm run typecheck
npm run build
```

semantic-release 실패

커밋 메시지 형식 확인
GitHub Token 권한 확인
필요시 --dry-run으로 테스트:
```
npx semantic-release --dry-run
```

검증

릴리스 전 확인 사항

npm run lint 통과
npm run typecheck 통과
npm run build 성공
Conventional Commit 형식 준수

버전 스크립트 테스트

# 변경 사항 미리보기 (파일 수정 없음)
node scripts/update-version.mjs 4.0.0 --dry-run

2.6 KiB Raw Blame History