프로젝트/오픈소스 컨트리뷰톤

[backend.ai] #691. Add the commit history between releases in the release notes

soheeeeP 2022. 9. 14. 23:32
 

Add the commit history between releases in the release notes · Issue #691 · lablup/backend.ai

Let's append the actual commit history for each release by updating scripts/extract-release-changelog.py. Now we can skip changelogs for specific PRs, but sometimes we may still want to inspect...

github.com

 

✏️  Issue Contents

release note(CHANGELOG.md)에 커밋 히스토리 기록을 추가하도록 scripts/extract-release-changelog.py를 수정. 

✏️  Ideation & Issue Solving

이전에 release된 버전의 tag와 현재 release된 버전의 tag를 얻어와서, 전체 커밋 히스토리를 조회할 수 있는 링크를 CHANGELOG에 추가하면 될 것 같았다. 기능상으로 유의미한 변화를 가져오지는 않지만, 사용자(오픈소스 기여자 및 프로젝트 관리자) 편의성을 충분히 개선시킬 수 있는 작업이라고 생각했다.

  • 1a3063 스크립트 내부에서 git shell command를 실행하기 위해 subprocess 라이브러리(파이선 스크립트에서 다른 프로세스를 실행, 출력할 수 있다)를 사용했다.
  • 1a3063 이전~현재 버전 사이의 커밋 히스토리는 /compare/{prev_tag}...{current_tag} 링크를 통해 조회할 수 있었다. 스크립트를 실행하면 생성되는 CHANGELOG_RELEASE.md에 해당 링크가 추가되도록 수정했다.

scripts/extract-release-changelog.py

 

✏️  Pull Request Review

 

feat: Add commit history between releases by soheeeeP · Pull Request #721 · lablup/backend.ai

issue #691 Add commit history link between releases in release notes(CHANGELOG_RELEASE.md) by updating scripts/extract-release-changelog.py

github.com

리뷰완료. merge되었다.