Skip to content

RELEASE.md

Latest commit

 

History

History
94 lines (71 loc) · 3.24 KB

RELEASE.md

File metadata and controls

94 lines (71 loc) · 3.24 KB
Raw

Release Process

This document describes how to cut a release of Android Password Store (pando85 fork).

Overview

Releases are fully automated via GitHub Actions:

  1. Auto-tag (.github/workflows/auto-tag.yml): Watches app/version.properties on main. When a non-SNAPSHOT version is pushed, creates a GPG-signed git tag v<version>.
  2. Release (.github/workflows/release.yml): Triggered by tag push. Builds a signed release APK and publishes it to GitHub Releases with auto-generated changelog.

Cutting a release

# 1. Choose bump type based on changes: major / minor / patch

# 2. Bump version (or clear SNAPSHOT if version is already correct)
./gradlew :app:bumpPatch   # or bumpMinor, or bumpMajor
# If only removing -SNAPSHOT suffix:
./gradlew :app:clearPreRelease

# 3. Update CHANGELOG.md: rename [Unreleased] to [version] with today's date
#    Example: ## [1.17.1] - 2026-06-30

# 4. Commit and push
git add app/version.properties CHANGELOG.md
git commit -m "release: $(grep 'versionName' app/version.properties | cut -d= -f2)"
git push origin main

# 5. Wait ~8 minutes for CI to build and publish
#    Auto-tag creates GPG-signed tag → release.yml builds APK
#    Release notes are extracted from CHANGELOG.md entry

# 6. Verify
gh release view v$(grep 'versionName' app/version.properties | cut -d= -f2 | tr -d ' ')

CHANGELOG.md format

The release workflow reads the changelog entry matching the version being released. Entries must follow this format:

## [1.17.1] - 2026-06-30

### Added
- Feature description

### Changed
- Change description

### Fixed
- Fix description

If no entry is found for the version, the release fails.

Required secrets

Secret Purpose Source
PAT Push tags that trigger downstream workflows pass personal/github_pat_autotag
GPG_PRIVATE_KEY Sign git tags pass personal/github_gpg
KEYSTORE_BASE64 Base64-encoded release signing keystore base64 -w0 keystore.jks
KEYSTORE_PASSWORD Keystore store + key password keystore.properties
KEY_ALIAS Key alias in keystore keystore.properties

How it works

                        app/version.properties
                        versionName=1.17.0
                              │
                              ▼
                        push to main
                              │
                              ▼
                    ┌───────────────────┐
                    │   auto-tag.yml    │
                    │ GPG-signed tag    │
                    │   v1.17.0         │
                    └───────┬───────────┘
                            │ tag push
                            ▼
                    ┌───────────────────┐
                    │   release.yml     │
                    │ Build signed APK  │
                    │ GitHub Release    │
                    └───────────────────┘

The version follows semver. clearPreRelease removes a pre-release suffix; bumpMajor, bumpMinor, and bumpPatch increment the version directly.