Skip to content

yashvardhan-kukreja/whatsupstream

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

40 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation


๐Ÿš€ Whatsupstream ๐Ÿš€

A tool which will keep you up-to-date with the activity (issues) of your favorite Open Source repositories without any hassle or even opening browser.
Just tweak it according to your wants and it will notify on your desktop, if any issue meeting your criteria (like certain labels/creator) of any OSS repository got created. ๐Ÿ˜Ž

ยท Report Bug ยท Request Feature

Table of Contents

About Whatsupstream

Whatsupstream is a tool (CLI actually) which runs as a background process and tracks the activity associated with any Open Source repositories you tell it. (for now, it tracks issues)

Say, you want to be notified as soon as possible whenever an issue with good first issue and sig/node labels is created in Kubernetes

Just tell Whatsupstream (configure it, it's easy :P) about it and this tool will simply run behind the scenes and raise a desktop notification on your computer as soon it sees such kind of issue.

Benefit?

You can pick that issue up instantly before anyone picks it up :P, work on it and be a proud OSS contributor :D

PS: you can configure it for countless repositories as per your liking.

Getting Started

Here are instructions to setup and use whatsupstream.

Prerequisites

Just have make installed in your computer, rest all will be handled automatically for you.

Behind the scenes, this project entirely runs on GoLang but if you don't have it, no worries, make will set it up for you :)

Project Setup

  1. For getting the latest stable release
curl -L https://github.com/yashvardhan-kukreja/whatsupstream/archive/v0.1.tar.gz | tar xvz
cd whatsupstream-* && sudo make install
  1. Setup your whatsupstream configuration in YAML by referring to Whatsupstream Configuration Guide and save it in $HOME/.whatsupstream/config.yaml (preferable) or any other place.

  2. Run it as a background process ๐Ÿš€

    • If your whatsupstream config is at $HOME/.whatsupstream/config.yaml
    whatsupstream notify --background
    • If your whatsupstream config is at some other place, say, /path/to/other/place/whatsupstream.yaml
    whatsupstream notify --background --config /path/to/other/place/whatsupstream.yaml

OR

  1. Just run it as a foreground process with:
whatsupstream notify --config /path/to/config.yaml

Whatsupstream runs as a background process. So, to stop all the instances of whatsupstream, just run:

whatsupstream stop

Whatsupstream in action

Whatsupstream

Contributing

Refer to the Developer's Guide for a detailed explanation of developing over, testing and contributing to whatsupstream.

License

Distributed under the Apache License Version 2.0. See LICENSE for more information.

Acknowledgements

About

๐Ÿš€ A tool to keep you up-to-date with the issues (good first issues, for eg. ;) of your favorite open source repositories

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published