https://github.com/berkguzel/github-weekly-report
watches your repositores and sends notification once in week
https://github.com/berkguzel/github-weekly-report
docker github github-golang go golang
Last synced: 3 months ago
JSON representation
watches your repositores and sends notification once in week
- Host: GitHub
- URL: https://github.com/berkguzel/github-weekly-report
- Owner: berkguzel
- License: apache-2.0
- Created: 2020-12-10T18:35:48.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-03-30T19:35:31.000Z (about 5 years ago)
- Last Synced: 2024-06-20T22:34:29.959Z (almost 2 years ago)
- Topics: docker, github, github-golang, go, golang
- Language: Go
- Homepage:
- Size: 9.44 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# github-weekly-report
#### `github-weekly-report` watches your repositories, specified by you, and notifies you on Telegram about what occurred on your repositories.
# USAGE
**ACCESS_TOKEN** = Github Access Token.
**OWNER** = Owner of the Github account.
**REPOSITORY** = Name of your repositories you want to get notification.
- You can pass ```all```
- REPOSITORY="all"
- You can pass many repositories by seperating them using comma
- REPOSITORY="repository1, repository2"
**CHATID** = Telegram provides CHATID in response of this url `https://api.telegram.org/bot/getUpdates?offset=0`
**TOKEN** = Telegram provides TOKEN when you created a Bot.
## You can run also without Docker but firstly you should pass the variables.
```
export ACCESS_TOKEN="" \
> OWNER="" \
> REPOSITORY="" \
> CHATID="" \
> TOKEN="" \
```
## Docker
```
docker build -t github-weekly-report .
```
```
docker run -d --restart \
> -e ACCESS_TOKEN="" \
> -e OWNER="" \
> -e REPOSITORY="" \
> -e CHATID="" \
> -e TOKEN="" \
> github-weekly-report
```
You can also use [ko](https://github.com/google/ko/) to create image.
```
docker run -d --restart $(ko publish ./cmd) \ ...
```
#### ``` INTERVAL``` and ```FORK``` choices are also available. You may change your time interval to get notification and see the occurred stuffs on your repositories you forked.
You can get your notifications as daily, hourly or in minutes.
Default value is weekly.
```
> INTERVAL = 1h -> notify you once in a hour.
> FORK = true -> notify you about forked repositories
```
# DEMO
