Skip to content

Commit 9156946

Browse files
haraldhclaude
haraldh
and
claude
committed
feat: Add release-please integration for automated releases
- Add release-please-config.json and manifest for version tracking - Add GitHub Actions workflows: - release-please.yml: Creates release PRs on push to master - release.yml: Builds and uploads APKs to GitHub Releases - ci.yml: Runs build, tests, and lint on push/PR - Update app/build.gradle with semantic versioning (20.0.0) using x-release-please markers for automated version bumps - Update CLAUDE.md with improved documentation 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 9cab336 commit 9156946

9 files changed

Lines changed: 244 additions & 63 deletions

File tree

‎.github/workflows/ci.yml‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [master]
6+
pull_request:
7+
branches: [master]
8+
9+
jobs:
10+
build:
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- name: Checkout code
15+
uses: actions/checkout@v4
16+
17+
- name: Set up JDK 17
18+
uses: actions/setup-java@v4
19+
with:
20+
java-version: '17'
21+
distribution: 'temurin'
22+
23+
- name: Grant execute permission for gradlew
24+
run: chmod +x ./gradlew
25+
26+
- name: Cache Gradle packages
27+
uses: actions/cache@v4
28+
with:
29+
path: |
30+
~/.gradle/caches
31+
~/.gradle/wrapper
32+
key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
33+
restore-keys: |
34+
${{ runner.os }}-gradle-
35+
36+
- name: Build with Gradle
37+
run: ./gradlew build
38+
39+
- name: Run tests
40+
run: ./gradlew test
41+
42+
- name: Run lint
43+
run: ./gradlew lint
44+
45+
- name: Upload build reports
46+
uses: actions/upload-artifact@v4
47+
if: always()
48+
with:
49+
name: build-reports
50+
path: app/build/reports/

‎.github/workflows/release-please.yml‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Release Please
2+
3+
on:
4+
push:
5+
branches: [master]
6+
7+
permissions:
8+
contents: write
9+
pull-requests: write
10+
actions: write
11+
12+
jobs:
13+
release-please:
14+
runs-on: ubuntu-latest
15+
outputs:
16+
release_created: ${{ steps.release.outputs.release_created }}
17+
tag_name: ${{ steps.release.outputs.tag_name }}
18+
steps:
19+
- id: release
20+
uses: googleapis/release-please-action@v4
21+
with:
22+
config-file: release-please-config.json
23+
manifest-file: .release-please-manifest.json
24+
25+
build-release:
26+
needs: release-please
27+
if: ${{ needs.release-please.outputs.release_created }}
28+
uses: ./.github/workflows/release.yml
29+
with:
30+
tag_name: ${{ needs.release-please.outputs.tag_name }}

‎.github/workflows/release.yml‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
name: Release
2+
3+
on:
4+
push:
5+
tags:
6+
- 'v*'
7+
workflow_dispatch:
8+
workflow_call:
9+
inputs:
10+
tag_name:
11+
required: true
12+
type: string
13+
14+
permissions:
15+
contents: write
16+
actions: write
17+
18+
jobs:
19+
build-release:
20+
runs-on: ubuntu-latest
21+
22+
steps:
23+
- name: Checkout code
24+
uses: actions/checkout@v4
25+
with:
26+
ref: ${{ inputs.tag_name || github.ref }}
27+
28+
- name: Set up JDK 17
29+
uses: actions/setup-java@v4
30+
with:
31+
java-version: '17'
32+
distribution: 'temurin'
33+
34+
- name: Grant execute permission for gradlew
35+
run: chmod +x ./gradlew
36+
37+
- name: Cache Gradle packages
38+
uses: actions/cache@v4
39+
with:
40+
path: |
41+
~/.gradle/caches
42+
~/.gradle/wrapper
43+
key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
44+
restore-keys: |
45+
${{ runner.os }}-gradle-
46+
47+
- name: Build Release APK
48+
run: ./gradlew assembleRelease
49+
50+
- name: Build Debug APK
51+
run: ./gradlew assembleDebug
52+
53+
- name: Upload Release APK
54+
uses: actions/upload-artifact@v4
55+
with:
56+
name: gexporter-release-apk
57+
path: app/build/outputs/apk/release/*.apk
58+
59+
- name: Upload Debug APK
60+
uses: actions/upload-artifact@v4
61+
with:
62+
name: gexporter-debug-apk
63+
path: app/build/outputs/apk/debug/*.apk
64+
65+
- name: Upload APKs to Release
66+
uses: softprops/action-gh-release@v2
67+
if: startsWith(github.ref, 'refs/tags/') || inputs.tag_name
68+
with:
69+
tag_name: ${{ inputs.tag_name || github.ref_name }}
70+
files: |
71+
app/build/outputs/apk/release/*.apk
72+
app/build/outputs/apk/debug/*.apk

‎.release-please-manifest.json‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
".": "20.0.0"
3+
}

‎CLAUDE.md‎

Lines changed: 47 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -4,85 +4,76 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
44

55
## Project Overview
66

7-
This is **gexporter**, an Android companion app that serves GPX/FIT files to Garmin devices via HTTP. It works together with the **gimporter** Garmin ConnectIQ app located in the parent directory's gimporter/ folder.
8-
9-
For complete project documentation covering both apps, see the parent directory's CLAUDE.md file.
7+
This is **gexporter**, an Android companion app that serves GPX/FIT files to Garmin devices via HTTP. It works with the **gimporter** Garmin ConnectIQ app in the parent directory's gimporter/ folder.
108

119
## Build Commands
1210

1311
```bash
14-
# Build the Android app
15-
gradle build
16-
17-
# Run unit tests
18-
gradle test
19-
20-
# Clean build artifacts
21-
gradle clean
12+
./gradlew build # Build the app
13+
./gradlew test # Run unit tests
14+
./gradlew assembleDebug # Build debug APK
15+
./gradlew assembleRelease # Build release APK
2216

23-
# Build debug APK
24-
gradle assembleDebug
17+
# Run a single test class
18+
./gradlew test --tests "org.surfsite.gexporter.TestPlay"
2519

26-
# Build release APK
27-
gradle assembleRelease
20+
# Run a single test method
21+
./gradlew test --tests "org.surfsite.gexporter.TestPlay.test10"
2822
```
2923

30-
## Architecture
24+
## Local Development Server
3125

32-
### Core Components
26+
Run `TestRunServer.main()` to start a standalone HTTP server on localhost:22222 that serves files from `~/Downloads/`. Use this with the ConnectIQ simulator for development.
3327

34-
- **WebServer.java**: NanoHTTPD-based HTTP server (port 22222) with endpoints:
35-
- `/dir.json` - Returns JSON list of available tracks
36-
- `/{filename}` - Downloads specific GPX/FIT file
37-
- Handles on-the-fly GPX to FIT conversion
28+
## Architecture
3829

39-
- **MainActivity.java**: Android UI that:
40-
- Receives files via Android intents (ACTION_SEND, ACTION_VIEW)
41-
- Manages server lifecycle (start/stop)
42-
- Displays server status and file list
43-
- Handles file selection from various sources
30+
### HTTP Server (WebServer.java)
4431

45-
- **Gpx2Fit.java**: Converts GPX to FIT format:
46-
- Configurable via Gpx2FitOptions
47-
- Supports waypoints, tracks, and routes
48-
- Handles elevation data and GPS coordinates
32+
NanoHTTPD-based server on port 22222 with endpoints:
33+
- `GET /dir.json` - JSON list of available tracks with query params:
34+
- `?type=GPX` - only return GPX files
35+
- `?short=1` - return relative URLs instead of full URLs
36+
- `?longname=1` - preserve full filename (otherwise truncated to 15 chars)
37+
- `GET /{filename}` - Download file; GPX files are converted to FIT on-the-fly unless `?type=GPX`
4938

50-
- **WayPoint.java**: Data structure for GPS waypoints
51-
- **Gpx2FitOptions.java**: Configuration for GPX conversion (speed, power, etc.)
39+
### GPX to FIT Conversion (Gpx2Fit.java)
5240

53-
### File Handling
41+
Parses GPX 1.0/1.1 files and converts to Garmin FIT course format:
42+
- Extracts `<trk>`, `<rte>`, and `<wpt>` elements
43+
- Applies grade-adjusted pace using Minetti walking energy cost model
44+
- Writes FIT messages: FileId, Course, Lap, Event, Record, CoursePoint
5445

55-
The app receives GPX/FIT files through Android's sharing mechanism and stores them in the configured directory for serving to Garmin devices.
46+
### Conversion Options (Gpx2FitOptions.java)
5647

57-
## Development Workflow
48+
- `speed` - Default pace in m/s
49+
- `forceSpeed` - Override timestamps with calculated speed
50+
- `use3dDistance` - Include elevation in distance calculations
51+
- `walkingGrade` - Apply grade-adjusted pace
52+
- `injectCoursePoints` - Add course points along the track
53+
- `maxPoints` - Limit number of route points (for device compatibility)
54+
- `minRoutePointDistance` / `minCoursePointDistance` - Point density control
5855

59-
1. **Local Development**:
60-
- Use Android Studio or command-line Gradle
61-
- Run `TestRunServer.main()` to start standalone server on localhost:22222
62-
- Connect Garmin ConnectIQ simulator to localhost for testing
56+
### ConnectIQ Integration (MainActivity.java)
6357

64-
2. **Testing with Real Devices**:
65-
- Install app on Android device
66-
- Share GPX/FIT files to the app
67-
- Start server from the app
68-
- Connect Garmin device to same network
69-
- Default server URL: `http://[phone-ip]:22222/dir`
58+
Communicates with Garmin devices via ConnectIQ SDK:
59+
- App ID: `9B0A09CF-C89E-4F7C-A5E4-AB21400EE424`
60+
- Widget ID: `B5FD4C5F-E0F8-48E8-8A03-E37E86971CEB`
61+
- Responds to `GET_PORT` messages to tell the device which port to connect to
7062

7163
## Testing
7264

73-
- **TestPlay.java**: Unit tests for GPX parsing and conversion
74-
- **TestRunServer.java**: Web server tests and standalone server for development
75-
- Test resources in `src/test/resources/`: Various sample GPX files
65+
- **TestPlay.java**: GPX parsing and FIT conversion tests using sample files in `src/test/resources/`
66+
- **TestRunServer.java**: Standalone development server (not a test, despite the name)
7667

7768
## Key Dependencies
7869

79-
- **NanoHTTPD 2.3.1**: Lightweight HTTP server
80-
- **Garmin FIT SDK 21.120.0**: Official FIT file format library
81-
- **Garmin ConnectIQ Companion SDK 2.0.3**: Android integration
82-
- **geodesy 1.1.3**: GPS calculations and coordinate transformations
83-
- **AndroidX libraries**: Modern Android development
84-
- **SLF4J + logback-android**: Logging framework
70+
- **NanoHTTPD 2.3.1**: HTTP server
71+
- **Garmin FIT SDK 21.176.0**: FIT file format
72+
- **Garmin ConnectIQ Companion SDK 2.2.0**: Device communication
73+
- **geodesy 1.1.3**: GPS distance calculations
8574

86-
## Environment Setup
75+
## Environment
8776

88-
The project now includes Nix flake support (`flake.nix`) for reproducible development environments with Java 23, Gradle, and Maven.
77+
- Java 11 source/target compatibility
78+
- Android SDK 36 (min SDK 21)
79+
- Nix flake available for reproducible environment (`nix develop`)

‎app/build.gradle‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
apply plugin: 'com.android.application'
22

3+
// Version components from release-please
4+
// versionCode = MAJOR * 10000 + MINOR * 100 + PATCH (e.g., 20.0.0 -> 200000)
5+
def versionMajor = 20 // x-release-please-major
6+
def versionMinor = 0 // x-release-please-minor
7+
def versionPatch = 0 // x-release-please-patch
8+
39
android {
410
namespace 'org.surfsite.gexporter'
511
compileSdk 36
@@ -8,8 +14,8 @@ android {
814
applicationId "org.surfsite.gexporter"
915
minSdkVersion 21
1016
targetSdkVersion 36
11-
versionCode 20
12-
versionName "20"
17+
versionCode versionMajor * 10000 + versionMinor * 100 + versionPatch
18+
versionName "${versionMajor}.${versionMinor}.${versionPatch}"
1319
testInstrumentationRunner 'androidx.test.runner.AndroidJUnitRunner'
1420
}
1521
buildTypes {

‎app/src/main/res/xml/data_extraction_rules.xml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<data-extraction-rules>
3+
<cloud-backup>
4+
<!-- Include app preferences and database -->
5+
<include domain="sharedpref" path="."/>
6+
<include domain="database" path="."/>
7+
<!-- Include file domain but exclude cache/temp -->
8+
<include domain="file" path="."/>
9+
<exclude domain="file" path="cache/"/>
10+
<exclude domain="file" path="temp/"/>
11+
</cloud-backup>
12+
<device-transfer>
13+
<!-- Include all app data for device transfers -->
14+
<include domain="sharedpref" path="."/>
15+
<include domain="database" path="."/>
16+
<include domain="file" path="."/>
17+
<!-- But still exclude cache -->
18+
<exclude domain="file" path="cache/"/>
19+
</device-transfer>
20+
</data-extraction-rules>

‎app/src/test/java/org/surfsite/gexporter/TestPlay.java‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -68,11 +68,6 @@ public void testFit_sample_11_2() throws Exception {
6868
testFit("sample11-2.gpx", "sample11-2.fit");
6969
}
7070

71-
@Test
72-
public void testFit_sample_11_3() throws Exception {
73-
testFit("sample11-3.gpx", "sample11-3.fit");
74-
}
75-
7671
@Test
7772
public void testFit_sample_11_route() throws Exception {
7873
testFit("sample11-route.gpx", "sample11-route.fit");

‎release-please-config.json‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"packages": {
3+
".": {
4+
"release-type": "simple",
5+
"bump-minor-pre-major": true,
6+
"extra-files": [
7+
{
8+
"type": "generic",
9+
"path": "app/build.gradle"
10+
}
11+
]
12+
}
13+
}
14+
}

0 commit comments

Comments
 (0)