Code Monkey home page Code Monkey logo

cctray-hub's Introduction

cctray hub

This service translates the github workflow API to the CCTray (cc.xml) format to allow seeing your build chain status on your desktop in tools like BuildNotify or ccmenu

buildnotify example

where to find it

We provide docker images over here: https://hub.docker.com/r/hennr/cctray-hub/tags

how to use

cctray-hub provides dynamic URLs based on three strings that you need to provide:

  • repo owner
  • repo name
  • workflow name or id

http://localhost:8080/cctray/<organisation-or-owner>/<repo>/<workfow-name-or-id>

for cctray itself this will be:

http://localhost:8080/cctray/idealo/cctray-hub/gradle.yml

Note that cctray-hub will query builds from the main branch per default. If you need other (or even all) branches to get queried as well, feel free to open an issue.

accessing private repositories

If you want cctray-hub to translate private github actions into the cctray format, you need to provide a PAT that has read permissions for the repos. Provide it as an env variable like this:

GITHUB_API_TOKEN=YOUR_PAT

protecting the endpoints with basic auth

Basic auth can be autoconfigured by setting the following application properties:

cctray-hub.username=YOUR_USERNAME

cctray-hub.password=YOUR_PASSWORD

access logs in JSON format

Access logs via logback and JSON log format can be enabled by setting the following profile:

SPRING_PROFILES_ACTIVE=json-log-format

references

CCTray spec

github docs regarding workflows

credits

cctray-hub is heavily inspired by this project: https://github.com/joejag/github-cctray

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.