Skip to content

Commit c1b2ee6

Browse files
RSainarayanRSainarayan
authored
Create Build_Download_guide.md (#73)
Created Docs foe downloading the build specific for multiple devices.
2 parents 09e461b + a585793 commit c1b2ee6

1 file changed

Lines changed: 134 additions & 0 deletions

File tree

‎BUILD_DOWNLOAD_GUIDE.md‎

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
# How to Download a Build for Your Garmin Watch
2+
3+
This guide explains how to get the latest app file (`.prg`) for your specific Garmin device from our automated build system — no technical knowledge required.
4+
5+
---
6+
7+
## What is a "build" and where does it come from?
8+
9+
Every time code is pushed to this repository, GitHub automatically compiles a separate app file for each of the 16 supported Garmin devices. These files are called **artifacts**. Think of it like a factory that runs automatically and produces a finished product for each watch model.
10+
11+
There are two ways to get a build:
12+
13+
| Where to look | Best for | How long it stays available |
14+
|---|---|---|
15+
| **GitHub Actions** (artifacts) | Testing a specific code change or branch | 7–30 days |
16+
| **GitHub Releases** | Stable, approved versions | Permanently |
17+
18+
---
19+
20+
## Supported Devices
21+
22+
Find your device model in the table below to know which file to download.
23+
24+
| Your Watch | File to Download |
25+
|---|---|
26+
| Garmin Fenix 7 | `garminsmartwatch_fenix7.prg` |
27+
| Garmin Fenix 7 Pro | `garminsmartwatch_fenix7pro.prg` |
28+
| Garmin Fenix 7S | `garminsmartwatch_fenix7s.prg` |
29+
| Garmin Fenix 7X | `garminsmartwatch_fenix7x.prg` |
30+
| Garmin Forerunner 165 | `garminsmartwatch_fr165.prg` |
31+
| Garmin Forerunner 165 Music | `garminsmartwatch_fr165m.prg` |
32+
| Garmin Forerunner 245 | `garminsmartwatch_fr245.prg` |
33+
| Garmin Forerunner 245 Music | `garminsmartwatch_fr245m.prg` |
34+
| Garmin Forerunner 255 | `garminsmartwatch_fr255.prg` |
35+
| Garmin Forerunner 255 Music | `garminsmartwatch_fr255m.prg` |
36+
| Garmin Forerunner 255S | `garminsmartwatch_fr255s.prg` |
37+
| Garmin Forerunner 255S Music | `garminsmartwatch_fr255sm.prg` |
38+
| Garmin Forerunner 265 | `garminsmartwatch_fr265.prg` |
39+
| Garmin Forerunner 265S | `garminsmartwatch_fr265s.prg` |
40+
| Garmin Forerunner 955 | `garminsmartwatch_fr955.prg` |
41+
| Garmin Vivo Active 5 | `garminsmartwatch_vivoactive5.prg` |
42+
43+
---
44+
45+
## Option A — Download from a GitHub Release (Recommended for stable builds)
46+
47+
Releases are official versions that have been tested and approved. Files here are available permanently.
48+
49+
**Step 1** — Go to the repository on GitHub.
50+
51+
**Step 2** — On the right-hand side of the page, look for the **"Releases"** section. Click on it.
52+
53+
> If you don't see it on the right side, look for a **"Releases"** link near the top of the page or scroll down.
54+
55+
**Step 3** — You will see a list of releases, each labelled with a version number (e.g. `v1.2.0`). Click on the latest one at the top (or whichever version you need).
56+
57+
**Step 4** — Scroll down to the **"Assets"** section at the bottom of that release page.
58+
59+
**Step 5** — You will see a list of `.prg` files — one for each device. Find your device in the table above and click the matching file name to download it.
60+
61+
---
62+
63+
## Option B — Download from GitHub Actions (For testing in-progress code)
64+
65+
Use this when you need a build from a specific branch or code change that has not been released yet. These files have an expiry: **7 days** for `develop` branch builds and **30 days** for `main` branch builds.
66+
67+
**Step 1** — Go to the repository on GitHub.
68+
69+
**Step 2** — Click on the **"Actions"** tab near the top of the page.
70+
71+
![Actions tab is in the top navigation bar of the repository]
72+
73+
**Step 3** — On the left side, you will see a list of workflows. Choose the one that matches what you need:
74+
75+
- **"CI — Develop"** — builds from the `develop` branch (in-progress work, expires in 7 days)
76+
- **"CI — Main"** — builds from the `main` branch (the latest approved code, expires in 30 days)
77+
78+
**Step 4** — You will see a list of runs, each showing when it ran and whether it passed (green checkmark) or failed (red X). Click on the most recent run with a **green checkmark**.
79+
80+
> Only successful runs (green checkmark) will have downloadable files.
81+
82+
**Step 5** — Scroll down to the bottom of the run page until you see a section called **"Artifacts"**.
83+
84+
**Step 6** — You will see entries named like `fenix7-abc1234`, `fr265-abc1234`, etc. The first part is the device name. Find the one that matches your watch (refer to the device table above) and click it to download a `.zip` file.
85+
86+
**Step 7** — Unzip the downloaded file. Inside you will find the `.prg` file for your device (e.g. `garminsmartwatch_fenix7.prg`).
87+
88+
---
89+
90+
## How to Install the App on Your Watch
91+
92+
Once you have the `.prg` file, you can install it onto your Garmin watch using one of these two methods:
93+
94+
### Method 1 — Garmin Express (PC or Mac)
95+
96+
1. Connect your watch to your computer with its USB cable.
97+
2. Open **Garmin Express**.
98+
3. In Garmin Express, go to your device's page and look for an option to manually add or sideload a Connect IQ app.
99+
4. Browse to and select the `.prg` file you downloaded.
100+
5. Sync your device. The app will appear on your watch.
101+
102+
### Method 2 — Garmin Connect IQ Mobile App
103+
104+
1. Enable **Developer Mode** in the Connect IQ app on your phone:
105+
- Open the **Connect IQ** app.
106+
- Tap the menu (three lines) → **Settings** → enable **Developer Mode**.
107+
2. Tap **Load Device App**.
108+
3. Choose the `.prg` file from your phone's storage.
109+
4. Follow the prompts to send it to your paired watch.
110+
111+
---
112+
113+
## Frequently Asked Questions
114+
115+
**Q: I cannot find the Artifacts section — where is it?**
116+
Artifacts only appear on runs that completed successfully (green checkmark). If the run failed, there are no files to download. Try selecting a different run that shows a green checkmark.
117+
118+
**Q: The artifact for my device is missing.**
119+
If one device's build failed while others succeeded, that device's artifact will not appear. Check the run logs by clicking on the failed job for details, or notify the development team.
120+
121+
**Q: The build I downloaded is more than 7 / 30 days old and is gone.**
122+
Artifacts are automatically deleted after their retention period. For the `develop` branch this is 7 days; for `main` it is 30 days. Ask the development team to trigger a new build, or use an official Release instead (Option A), which never expires.
123+
124+
**Q: Which branch should I use for QA testing?**
125+
- Use **"CI — Develop"** builds when you are testing features that are still being worked on.
126+
- Use **"CI — Main"** builds when you want the latest code that has passed code review.
127+
- Use a **Release** build when you need a stable, versioned snapshot for sign-off.
128+
129+
**Q: I have a Fenix 7 Pro Sapphire Solar. Which file do I use?**
130+
The `fenix7pro` build covers all Fenix 7 Pro variants (including Sapphire Solar). Download `garminsmartwatch_fenix7pro.prg`.
131+
132+
---
133+
134+
*For any issues or questions, please contact the development team.*

0 commit comments

Comments
 (0)