From 762a05521ea7d5d140272f9b079171344668fc2d Mon Sep 17 00:00:00 2001 From: Abhijeet Singh Date: Tue, 7 Aug 2018 00:25:59 +0530 Subject: [PATCH] Add Weekly Digest app https://github.com/apps/weekly-digest --- _apps/weekly-digest.md | 43 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 _apps/weekly-digest.md diff --git a/_apps/weekly-digest.md b/_apps/weekly-digest.md new file mode 100644 index 0000000..01fb8cf --- /dev/null +++ b/_apps/weekly-digest.md @@ -0,0 +1,43 @@ +--- +# A human-friendly name of your listing +title: Weekly Digest +# A short description of what your app does +description: Weekly Automated Summary of activities and happening on your GitHub repository +# The slug of your hosted app on GitHub (https://github.com/apps/YOUR-SLUG) +slug: weekly-digest +# Include a few screenshots that show your app in action +screenshots: +- https://user-images.githubusercontent.com/20141002/41304450-d2bc9234-6e8d-11e8-965d-649ed2d04651.gif +# The GitHub usernames of anyone who authored the app +authors: [ abhijeetps ] +# The repository where the code is located +repository: probot/weekly-digest +# The address where this app is deployed +host: https://weekly-digest.now.sh/ +--- +> App built using [Probot](https://probot.github.io/) which generates an automated summary of activities and happening on your GitHub repository. + +## App in Action ## +![A Weekly Digest generated by app.](https://user-images.githubusercontent.com/20141002/41304450-d2bc9234-6e8d-11e8-965d-649ed2d04651.gif) + +## Features ## + +When the Weekly Digest App gets installed in a repository of a user or organization, it curates together the following data and publishes it as an issue: + +- Issues created in the last one week + - Open Issues + - Closed Issues + - Noisy Issue + - Liked Issue +- Pull requests opened, updated, or merged in the last pull request + - Opened Pull Requests + - Updated Pull Requests + - Merged Pull Requests +- Commits made in the master branch, in the last week +- Contributors, adding contributions in the last week +- Stargazers, or the fans of your repositories, who really loved your repo +- Releases, of the project you are working on + +The app, as the name suggests, generates these digests and publishes it on weekly basis, typically on a Sunday. + +One can change the default configuration of the app by adding a _.github/weekly-digest.yml_ file in their GitHub repository, which allows them to configure the publish day and the specific information included in the digest.