Files

106 lines
1.7 KiB
Markdown

# Release procedure
This document describes epub-translator release procedure.
### Prepare a release commit
##### Create a release branch
```
git checkout -b release-<version>
```
##### Update version variables in build.gradle
gradle.properties
```
ePubTranslatorVersion=<version>.RELEASE
latestReleasedEPubTranslatorVersion=<version>.RELEASE
```
##### Create a release commit
```
git commit -a -m "Release <version>.RELEASE"
```
##### Push the release branch
```
git push origin release-<version>
```
##### Create a pull request
create a pull request with following title: `Release <version>.RELEASE`
##### Check the build status & Merge the pull request
Check the build status & merge the pull request.
### Prepare a release tag
##### Prepare a release note
generate a release note draft
```
./gradlew generateReleaseNote
```
update the release note draft (`build/release-note.md`) properly with your editor.
##### Create a release tag
```
git tag <version>.RELEASE
```
### Ship the release
##### Push the release tag
```
git push origin <version>.RELEASE
```
##### Update the release note on GitHub
Update the release note on GitHub
### Declare new version development start
##### Create a branch
```
git checkout -b <new version>-development
```
##### Update version variables in build.gradle
gradle.properties
```
ePubTranslatorVersion=<new version>-SNAPSHOT
latestReleasedEPubTranslatorVersion=<version>.RELEASE
```
##### Commit the change
```
git commit -a -m "Start <new version> development"
```
##### Push the release branch
```
git push origin <new version>-development
```
##### Check the build status
Check the build status before continue.
##### Merge the pull request
merge the pull request and delete the branch.