Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/probot/weekly-digest
Weekly summary of activity on your GitHub repository :calendar:
https://github.com/probot/weekly-digest
bot github-app gsoc gsoc-2018 jest nodejs probot probot-app weekly-digest
Last synced: about 2 months ago
JSON representation
Weekly summary of activity on your GitHub repository :calendar:
- Host: GitHub
- URL: https://github.com/probot/weekly-digest
- Owner: abhijeetps
- License: isc
- Created: 2018-04-30T16:49:39.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-24T02:29:03.000Z (over 1 year ago)
- Last Synced: 2024-04-09T16:21:17.565Z (5 months ago)
- Topics: bot, github-app, gsoc, gsoc-2018, jest, nodejs, probot, probot-app, weekly-digest
- Language: JavaScript
- Homepage: https://github.com/apps/weekly-digest
- Size: 2.66 MB
- Stars: 238
- Watchers: 5
- Forks: 29
- Open Issues: 44
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome - weekly-digest - Weekly summary of activity on your GitHub repository :calendar: (JavaScript)
README
# Weekly Digest
> App built using [Probot](https://probot.github.io/) which generates a weekly automated summary of activities and happening on your GitHub repository.
## App in Action
## Installation
1. Explore Weekly Digest app here: [GitHub Apps - Weekly Digest](https://github.com/apps/weekly-digest)
2. Now, click install and confim your installation location.
3. Your app is ready and is live, visit your repository to check out the weekly digest the app has published!
## 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_](docs/configuration.md) file in their GitHub repository, which allows them to configure the publication day and the specific information included in the digest.
## How to Contribute
1. Fork this repository.
2. Clone the forked repository on your development machine.
3. Move into your project's directory: `cd weekly-digest`
4. Run `npm install` to setup the project.
5. Follow [Configuring a GitHub App](https://probot.github.io/docs/development/#configuring-a-github-app) too configure your app on your development machine.
6. Follow [Running the app locally](https://probot.github.io/docs/development/#running-the-app-locally) to run your app on your development machine.
7. Before you add a feature or suggest some changes, we recommend [opening an issue here](https://github.com/probot/weekly-digest/issues/new) so that we can have a discussion about the changes.
8. Please make sure you run `npm test` before submitting a pull request. If possible, please add tests for your changes also.
## Code Style
The app is using [Javascript Standard Style](https://standardjs.com/) for linting.
## Test Framework
The app is using [Jest](https://jestjs.io/) for Javascript testing.
## Credits
This project is developed and maintained by [Abhijeet Singh](https://github.com/abhijeetps).
It is one of the [Google Summer of Code 2018](https://summerofcode.withgoogle.com/) Projects.
[Click here to view this Project \"Weekly Digest\" on Google Summer of Code 2018 Projects](https://summerofcode.withgoogle.com/projects/#5611987044663296)
I would like to thanks [Gregor Martynus](https://github.com/gr2m) and [Wilhelm Klopp](https://github.com/wilhelmklopp) for being really awesome mentors and guiding me for this project. :heart: