santima10 / devops-streamdeck Goto Github PK

View Code? Open in Web Editor NEW

97.0 4.0 14.0 1.7 MB

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

License: MIT License

CSS 56.24% HTML 0.63% JavaScript 0.07% TypeScript 43.06%

ci cd stream-deck gitlab-ci github-actions netlify vercel travis-ci hacktoberfest

devops-streamdeck's Introduction

DevOps for Stream Deck

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

How it works?

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.

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.

For Notifications

You have to create a new Personal Token with notifications scopes, otherwise you don't have access to your notifications.

GitLab

Show information

You have to create a new Personal Access Token. Set the scope as follows:

Required for	Scope
CI Status	`read_api`
MRs	`read_api`
ToDos	`read_user`

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

Install all the dependencies

yarn

Build the project for the first time, the project uses Parcel as bundler to handle React and TypeScript

yarn build

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

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

Steam Deck SDK docs

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.

devops-streamdeck's People

Contributors

Stargazers

Watchers

Forkers

yacman udondan bogeysparadise ergoz jairoandrescastaneda akamas pwnyprod gl-njanz pyro-x smilexth thedaviddias hikki78 askagirl giant-jelly

devops-streamdeck's Issues

It always shows a green badge

Hello again and thanks again.
I have configured two different repositories, and they always show a green badge, even though one of them has failed. I have checked the API responses from github and they correctly report the status of failed.

Also, I have another account setup for vercel and I'm getting a 401. It will be nice if the icon reflects that.

Open instructions in real browser and not In-Streamdeck

Document development setup

Hi.
I'm interested in your development setup for this plugin.
Could you document it so it's easier to contribute?
I tried to create all kinds of symlinks but Elgato won't recognize it as a plugin.

Add pipeline trigger

It would be great to be able to trigger a specific pipeline to run by the press of a button. It should be easy to implement, it's just a POST: https://docs.gitlab.com/ee/ci/triggers/#triggering-a-pipeline

Netlify

Improve the Button-Look

I'd suggest to improve the Button-Look since it is hard to identify which pipeline has passed or failed if we only see the GitLab logo and the status.

Here's a small mockup I made, the left button would be the easiest solution which only adds a title, to quickly identify the status of each pipeline I'd suggest to also add red/green indication and also parse the status:

GitLab support

Create a new action to support GitLab ;)

Azure DevOps Support

Is it possible to support azure devops using this plugin?

Vercel (formerly ZEIT) support

Misleading icon on Netlify status

Love the project!

Ran into a small issue yesterday.

This is the status of the last builds for my project on Netlify:

However, the icon shows an "error" icon:

I would expect the icon to reflect the "cancelled" status instead.

It would also be nice if there was a way to preserve the last non-cancelled status instead of scaring me :)

Keep up the good work!

Error on retrieving status

Hi there, I've installed your plugin and tried configuring it to query the pipeline status of my private project on gitlab.com.

I've registered an access token with the scope set to API.
The path to my project is gitlab.com/groupname/subgroupname/reponame
So I've configured the user (username/token) and left the domain field empty to use the default gitlab.com domain.
I've added the shortcut, selected my account and added the repo groupname/subgroup/reponame and left the branch empty.
To clarify: my username is absent from the repo reference. It is however my group and repo.
After pushing the button it states error only.

Could you please help me configure this properly?

Use fine-grained personal access tokens on GitHub

The classic personal access tokens have a higher risk if they get compromised / stolen compared to a fine-grained access token.

It would be nice if the README details which rights are needed so a fine-grained access toen can be used easily.

Cannot remove GitHub account

I have tried a fine-grained access token and now I cannot remove this account. Selecting the account, then clicking remove does not remove the account.

This is mandatory as new tokens, fine-grained or personal access tokens, must have an expire date.

Autorefesh

Allow enabling autorefresh via the action options.

Self-hosted GitLab

Please allow self-hosted GitLab servers (including http-only).

If you don't have the time you can assign this issue to me and I will do it within the next days :)

Edit accounts

Hello, and thanks for making this plugin and making it public.
I think it will be neat if you can edit added accounts. It is a bit tedious to have to re-create them from scratch if you made a typo or set an incorrect configuration.

Regards

List repositories

Add a refresh button to reload the repository list
Add a select to select the repository

Request: Travis-CI support

Most of the projects I help maintain use Travis-CI to run tests. I really love the idea of putting CI statuses on a Stream Deck device, and was excited when I saw this plugin in the list.

Note: I have no TypeScript experience, but if no one else is interested in this feature and implementing it falls to me, maybe I can figure out enough to be dangerous by cloning one of the existing actions. 😅

Stopped working

I have it set up for Github on a Mac.

It worked initially but once I got my first notification and appearing on the SD correctly, the notifications message stayed on and I got the red envelope icon.

Re-adding the Github account, I'm getting the same icon but it also now says "Undefined new notifications". Any idea what the problem is here?

santima10 / devops-streamdeck Goto Github PK

devops-streamdeck's Introduction

DevOps for Stream Deck

How it works?

Install this plugin

Configuration options

Compatible services

GitHub

For public repositories

For public/private repositories

For Notifications

GitLab

Netlify

Personal Token

Site ID

Vercel

Travis-CI.com / Travis-CI.org

How to setup the dev environment

Project structure

References

Contributing

Support the project

Issues

devops-streamdeck's People

Contributors

Stargazers

Watchers

Forkers

devops-streamdeck's Issues

Recommend Projects

Recommend Topics

Recommend Org