Skip to content

Commit ea25250

Browse files
committed
docs: add CI/CD build instructions to README
1 parent 4780b47 commit ea25250

1 file changed

Lines changed: 23 additions & 0 deletions

File tree

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,29 @@ Convert ADSB data to delay-Doppler truth - see a live instance at [http://adsb2d
99
- Outputs JSON data with a delay in km and Doppler in Hz.
1010
- Use the JSON output to map truth onto a delay-Doppler map, for example in [blah2](http://github.com/30hours/blah2).
1111

12+
## Building Docker Images (CI/CD)
13+
14+
To build and publish Docker images via GitHub Actions:
15+
16+
**Manual build (dev/testing):**
17+
1. Go to Actions → `docker-build` workflow
18+
2. Click "Run workflow"
19+
3. Set `tag` (e.g., `dev` or `v1.0.0`)
20+
4. Set `publish` to `true` to push to GHCR
21+
22+
**Release build (production):**
23+
1. Create and push a version tag:
24+
```bash
25+
git tag v1.0.0
26+
git push origin v1.0.0
27+
```
28+
2. The `release` workflow will automatically build and publish to `ghcr.io/offworldlabs/adsb2dd:<tag>`
29+
30+
**Pull the image:**
31+
```bash
32+
docker pull ghcr.io/offworldlabs/adsb2dd:v1.0.0
33+
```
34+
1235
## Usage
1336

1437
- Install docker and docker-compose on the host machine.

0 commit comments

Comments
 (0)