https://github.com/garlic0x1/gitwatch

Monitor Github for commits and send notifications
https://github.com/garlic0x1/gitwatch

Last synced: 3 months ago
JSON representation

Monitor Github for commits and send notifications

• Host: GitHub
• URL: https://github.com/garlic0x1/gitwatch
• Owner: garlic0x1
• Created: 2023-10-27T07:03:08.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2023-11-03T08:53:54.000Z (over 2 years ago)
• Last Synced: 2023-11-04T09:29:39.604Z (over 2 years ago)
• Language: Common Lisp
• Homepage:
• Size: 21.2 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.org

Awesome Lists containing this project

• awesome-cl-software - gitwatch - Notify a Discord channel when repos are updated. (Applications / Development Tools)

README

          
#+title: Gitwatch

Notify a Discord channel when repos are updated

* Usage

** Install

Dependencies:

- [[https://roswell.github.io/][Roswell]]

- [[https://www.quicklisp.org/beta/][Quicklisp]]

- [[https://github.com/garlic0x1/cl-workers][cl-workers]]

Modify ./config/secrets.lisp to use your Discord hook(s)

You can alter the database setup here if you want

Install executable:

#+begin_src shell

make install

#+end_src

** Add repositories to watch

#+begin_src shell

gitwatch repo add https://github.com/garlic0x1/gitwatch.git

#+end_src

you can confirm with this command:

#+begin_src shell

gitwatch repo ls

#+end_src

** Start scraping

*** Using `gitwatch service` (recommended)

#+begin_src shell

gitwatch service

#+end_src

*** Using cron:

Add this to your crontab:

`* * * * * ~/.local/bin/gitwatch scrape`

* Help

The CLI should have enough details in --help pages:

** gitwatch

#+begin_src

OPTIONS:

      --help     display usage information and exit

      --version  display version and exit

COMMANDS:

  migrate  Set up database (this will wipe any data you have accumulated)

  repo     Manipulate repositories

  scrape   Scrape repos and mail new commits

  service  Start as a service that scrapes periodically

#+end_src

** gitwatch repo

#+begin_src

OPTIONS:

      --help     display usage information and exit

      --version  display version and exit

COMMANDS:

  ls        List repos

  add       Add repo(s)

  rm        Remove repo(s)

  add-user  Add all public repos owned by user

  rm-user   Remove all repos owned by user(s)

  add-file  Add a list of URLs from a file

#+end_src

** gh api

The add-user and rm-user commands depend on the github CLI program to be installed and authenticated