Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tsimbalar/codemagic-build-monitor

Adapter to give access to Codemagic build status via the CatLight Protocol
https://github.com/tsimbalar/codemagic-build-monitor

build-status catlight codemagic

Last synced: about 1 month ago
JSON representation

Adapter to give access to Codemagic build status via the CatLight Protocol

Awesome Lists containing this project

README

        

![Main](https://github.com/tsimbalar/codemagic-build-monitor/workflows/Main/badge.svg?event=push)

# codemagic-build-monitor

Adapter to give access to Codemagic build status via the [CatLight Protocol](https://github.com/catlightio/catlight-protocol)

## How To

To use `codemagic-build-monitor` to monitor your Codemagic workflows, follow these steps :

### 1. Start the "proxy" locally

```
docker run --name codemagic-build-monitor -d -p 9902:9902 --restart unless-stopped ghcr.io/tsimbalar/codemagic-build-monitor
```

Open `http://localhost:9902/` in a browser to check that the server is up and running.

### 2. Get your Access Token
- Go to your Codemagic user settings at https://codemagic.io/settings
- Look for your Codemagic API token

### 3. Connecting Catlight to `codemagic-build-monitor`

In CatLight, you need to :

1. Add new connection
2. choose "CatLight-compatible"
3. Log in with :

- Url : `http://localhost:9902/builds`
- "Use token"
- paste your token

4. Connect

### 4. Choose the workflows you want to track

1. Select the workflows you want to monitor
2. Connect

### 5. Profit

Get notified about new builds, failing builds etc

## FAQ
### How to upgrade

If you followed the previous instructions, you should be able to run those commands :

```bash
docker stop codemagic-build-monitor
docker rm codemagic-build-monitor
docker pull ghcr.io/tsimbalar/codemagic-build-monitor:latest
docker run --name codemagic-build-monitor -d -p 9902:9902 --restart unless-stopped ghcr.io/tsimbalar/codemagic-build-monitor
```

---

## Roadmap