Skip to content

Latest commit

 

History

History
44 lines (40 loc) · 1.82 KB

README.md

File metadata and controls

44 lines (40 loc) · 1.82 KB

Build Status

circlecistatus

Get current build status of a repo on circleci from CLI

Usage with docker

curl https://raw.githubusercontent.com/kostyay/circlecistatus/master/bs.sh -o bs.sh && chmod +x ./bs.sh
echo alias bs=`pwd`/build_status.py >> ~/.bashrc
  • Follow configuration guide explained in Configuration
  • Run bs from project directory to get the current build status

Installation with source

  • Python3 is required
  • pip3 is required: sudo apt install python3-pip
  • Clone the repo git clone https://github.com/kostyay/circlecistatus.git
  • apt-get install libgit2-dev
  • pip3 install -r requirements.txt
  • Create an alias in your .bashrc: alias bs=/path/to/build_status.py.
    • bash: echo alias bs=`pwd`/build_status.py >> ~/.bashrc
    • zsh: echo alias bs=`pwd`/build_status.py >> ~/.zshrc
  • Run bs from project directory to get the current build status

Copy-Paste:

sudo apt install -y python3-pip libgit2-dev
git clone https://github.com/kostyay/circlecistatus.git
cd circlecistatus
pip3 install -r requirements.txt
echo alias bs=`pwd`/build_status.py >> ~/.bashrc

Configuration

Create a configuration file at the following path: ~/.circleci/build_status It should contain the following contents:

[build_status]
user_token = <<REPLACE>>
project_username = <<REPLACE>>
source_control = <<REPLACE>>
  • user_token - Go to CircleCI and generate a personal API token (https://circleci.com/account/api).
  • project_username - The repository you are working it. Normally when viewing builds from circle ci you can decude it from the URL. For example https://circleci.com/bb/<<project_username>>/<<project>/<<build_id>>
  • source_control - Either bitbucket or github