Comicviewer/docs/RELEASING.ko.md

118 lines
4.2 KiB
Markdown

# AppImage Release 배포 안내
지인에게 배포할 때는 AppImage를 Git 소스 이력에 추가하지 않고 Git 서버의
Release 첨부 파일로 제공하는 방식을 권장합니다. 버전별 바이너리를 커밋하면
저장소를 복제할 때 모든 과거 바이너리까지 내려받아 저장소가 빠르게 커집니다.
기존 `v0.1.0` AppImage 커밋은 배포 기록으로 유지하되, 다음 버전부터는 이
절차를 사용합니다.
태그, 프로젝트 버전, AppImage, 통합 번들의 버전은 반드시 같아야 합니다.
예를 들어 `v0.1.3` Release에는 이름에 `0.1.3`이 포함된 파일만 첨부합니다.
Git 태그만 푸시하면 첨부 파일은 자동으로 등록되지 않으므로, 마지막 단계에서
Release를 만들고 파일 네 개를 직접 첨부해야 합니다.
## 1. 버전 갱신
릴리스 전에 다음 위치의 버전이 일치하는지 확인합니다.
- `Cargo.toml`의 패키지 버전
- `data/io.github.comicviewer.Comicviewer.metainfo.xml`의 릴리스 버전과 날짜
- `packaging/build-appimage.sh`의 출력 파일 버전
## 2. 품질 검사
```sh
cargo fmt --check
cargo clippy --all-targets --all-features -- -D warnings
cargo test --all-features
```
모든 검사를 통과한 소스에서 AppImage를 빌드합니다.
## 3. AppImage 빌드
`appimagetool`을 직접 지정하거나, appimagetool을 포함한
`linuxdeploy-x86_64.AppImage`를 지정합니다. AppImage는 Arch/CachyOS 호스트의
GTK4와 dav1d를 사용하며 시스템 라이브러리를 내부에 복사하지 않습니다.
```sh
PATH="/path/to/appimage-tools:$PATH" \
LINUXDEPLOY="/path/to/appimage-tools/linuxdeploy-x86_64.AppImage" \
./packaging/build-appimage.sh
```
완성된 AppImage는 `dist/`에 생성됩니다. 배포 전에 직접 실행해 기본 화면이
열리는지 확인합니다.
## 4. 통합 배포 번들 생성
AppImage 빌드가 끝나면 다음 스크립트로 체크섬과 통합 `tar.gz` 번들을 한 번에
생성합니다.
```sh
./packaging/build-release-bundle.sh
```
스크립트는 `Cargo.toml`에서 버전을 읽고 다음 파일을 생성합니다.
- `dist/Comicviewer-0.1.3-x86_64.AppImage.sha256`
- `dist/Comicviewer-0.1.3-x86_64.tar.gz`
- `dist/Comicviewer-0.1.3-x86_64.tar.gz.sha256`
통합 번들에는 AppImage, 체크섬, 설치·업데이트 스크립트, 데스크톱 파일, 아이콘,
한국어 설치 안내문이 포함됩니다. `tar.gz`는 실행 권한과 디렉터리 구조를
보존하므로 ZIP보다 Linux 배포에 적합합니다.
생성된 번들의 압축 목록과 체크섬을 확인합니다.
```sh
tar -tzf dist/Comicviewer-0.1.3-x86_64.tar.gz
cd dist
sha256sum -c Comicviewer-0.1.3-x86_64.tar.gz.sha256
```
## 5. 소스 커밋과 태그
버전 변경과 문서를 커밋한 뒤 주석 태그를 생성하고 푸시합니다. AppImage 자체는
`git add -f`로 추가하지 않습니다.
```sh
git add Cargo.toml Cargo.lock data packaging README.md docs
git commit -m "Prepare v0.1.3 release"
git tag -a v0.1.3 -m "Comicviewer v0.1.3"
git push origin main
git push origin v0.1.3
```
이미 원격에 공개한 태그는 이동하거나 덮어쓰지 않습니다. 수정이 필요하면 새
패치 버전을 만듭니다.
## 6. Git 서버 Release 생성
Git 서버의 Releases 화면에서 푸시한 태그를 선택해 Release를 생성하고 다음
파일을 첨부합니다.
- `Comicviewer-0.1.3-x86_64.tar.gz`
- `Comicviewer-0.1.3-x86_64.tar.gz.sha256`
- `Comicviewer-0.1.3-x86_64.AppImage`
- `Comicviewer-0.1.3-x86_64.AppImage.sha256`
호스트 라이브러리형 AppImage는 크기가 작지만, 업로드 후에도 반드시 원격에서
다시 내려받아 체크섬과 실제 실행을 확인합니다.
Release 설명에는 주요 변경 사항과 함께 다음 요구사항을 안내합니다.
```text
지원 환경: CachyOS / Arch Linux x86_64
필수 패키지: fuse2, gtk4, dav1d, gvfs, gvfs-smb
권장 설치 또는 업데이트:
tar.gz와 tar.gz.sha256을 같은 폴더에 다운로드한 뒤 실행합니다.
sha256sum -c Comicviewer-0.1.3-x86_64.tar.gz.sha256
tar -xzf Comicviewer-0.1.3-x86_64.tar.gz
cd Comicviewer-0.1.3-x86_64
./install-or-update.sh
```
사용자에게는 [`INSTALL.ko.md`](INSTALL.ko.md) 문서를 함께 안내합니다.