https://github.com/nhalstead/circleci_build_watcher

Simple Desktop Widget to watch CircleCI Builds!
https://github.com/nhalstead/circleci_build_watcher

build-tool circleci continuous-integration electron react

Last synced: 2 days ago
JSON representation

Simple Desktop Widget to watch CircleCI Builds!

• Host: GitHub
• URL: https://github.com/nhalstead/circleci_build_watcher
• Owner: nhalstead
• License: mit
• Created: 2020-04-01T04:31:01.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-02-03T06:14:49.000Z (almost 2 years ago)
• Last Synced: 2024-05-28T14:58:59.681Z (8 months ago)
• Topics: build-tool, circleci, continuous-integration, electron, react
• Language: JavaScript
• Homepage:
• Size: 1.74 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

## Circle CI Build Watcher

This is a simple tool to watch what builds are running on CircleCI and allow you to open directly to that build.

This tool is a small window that will open up and connect to the CircleCI API using your [API Token from your Account](https://circleci.com/account/api)

  and return the following information in a handy UI.

  

 - Build Status

 - Build Number

 - Author

 - Repository & Branch

 - Pull Request (If present)

 

This tool supports using multiple circle CI accounts/token for when you have many organizations you need to watch builds on.

## Limitations

This will currently setup to show ONLY the latest build in the past 4 hours, in addition to the last 4 builds from each source listed.

All sorted by the `start_time` (no defined use from CircleCI but resolved to be the start time of the given build).

## How to start

At this point no releases are available so your only option is to clone the source code from github.

```

git clone https://github.com/nhalstead/circleci_build_watcher.git

```

Once you have it cloned you can then run the following command to install all of the needed libraries.

```

npm install

```

Finally you are ready to run, just run the following command to start the UI.

```

 npm start

```

Once it opens up nothing will be in the list so you will need to configure the Json File (UI Config is coming soon).

In this project I used `electron-store` which will store the file in one of the following locations:

| Operating System | Path                                                 |

|:-----------------|:-----------------------------------------------------|

| Windows          | %APPDATA%/circleci_build_watcher                     |

| Mac              | ~/Library/Application Support/circleci_build_watcher |

| Linux            | $XDG_CONFIG_HOME/circleci_build_watcher              |

| Linux            | ~/.config/circleci_build_watcher                     |

## The Config File

This config file is loaded on start and is never written to from the application (yet).

The Config file looks like this for simple use.

You can get the token from your account in each org by going to the following [URL](https://circleci.com/account/api).

##### Filename: `config.json`

```json

{

  "endpoints": [

    {

      "type": "github",

      "org": "example_org",

      "token": "xyz123"

    }

  ]

}

```