Awesome Open Source
Awesome Open Source

DevOps for Stream Deck Custom badge

Check the status of your CI/CD environments using your Stream Deck

How it works?

Install this plugin

You can find it at the Stream Deck Store.

Configuration options

Field Description Service Required
account Here you can select your Personal Token and custom domain if you use a self-hosted version. GitHub, GitLab, Netlify, Vercel, Travis Yes
username/repo Configure here the repo for GitLab/GitHub GitHub, GitLab, Travis Yes
siteId Your Netlify Site Id Netlify Yes
project name Your project name in Vercel Vercel Yes
branch Select the branch to monitor or leave it empty to show info from all branches. GitHub, GitLab, Netlify, Travis No

Compatible services

GitHub

Show information

For public repositories

You have to create a new Personal Token with the following scopes: repo:status, repo_deployment and public_repo.

image

For public/private repositories

You have to create a new Personal Token with all the repo scopes, otherwise you don't have access to your private repositories.

image

GitLab

Show information

You have to create a new Personal Token with the following scope: api.

image

Netlify

Show information

Personal Token

You have to create a new Personal Token.

Site ID

You can find your site id in the settings tab of your project, with the API ID name.

Vercel

Show information

You have to create a new Token.

Travis-CI.com / Travis-CI.org

Show information

You have to create a new Token.

By default the actions uses the travis-ci.org api, if you want to use it with travis-ci.com set https://api.travis-ci.com as domain in the configuration.

How to setup the dev environment

  1. Install all the dependencies
yarn
  1. Build the project for the first time, the project uses Parcel as bundler to handle React and TypeScript
yarn build
  1. Create a symlink form the folder you clone the repository
ln -s devops-streamdeck/dist/dev.santiagomartin.devops.sdPlugin ~/Library/Application\ Support/com.elgato.StreamDeck/Plugins/dev.santiagomartin.devops.sdPlugin
  1. Run the proper dev command, since we are using Parcel to build the project we have a few dev commands to start Parcel in watch mode
// For Property Inspector
yarn:dev:pi

// For Plugin
yarn:dev:plugin

// For setup screen, where the user add the configuration for each service
yarn:dev:setup

Project structure

.
 node_modules
 dist
 images
 node_modules
 release
 src
   dev.santiagomartin.devops.sdPlugin
     pi // all code related with Property Inspector (build with React and TypeScript)
     plugin // all code related with Plugin (build with TypeScript)
     setup // all code related with Setup page (build with React and TypeScript)
 tools // contains the elgato tools to build the project using GitHub Actions
 .babelrc
 .gitignore
 jest.config
 LICENSE
 manifest.json
 package.json
 README.md
 tsconfig.json
 yarn.lock

References

Contributing

Thank you for considering contributing to the DevOps for Stream Deck. Feel free to send in any pull requests.

Support the project

If you like the project, you can subscribe to my Twitch channel, where I do live coding of this and other projects.

Issues

Please report any issues. Ideas for new excuse features are also welcomed.


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
Css (215,282
Hacktoberfest (38,001
Github Actions (4,465
Ci (2,252
Netlify (2,099
Travis Ci (1,664
Vercel (1,450
Gitlab Ci (470
Cd (447
Streamdeck (155
Related Projects