tmr08c / weekly-summary-cron-with-now

Application that leverages Now to create a lambda to generate a list of recently closed GitHub Pull Requests for an Organization.

Weekly Summary Cron with Now

This application uses Now to produce a lambda that will generate a markdown-friendly list of recently closed pull requests for a given organization.

API

This appliation will creat a lambda that responds to HTTP GET requests, and takes in the following query parameters:

organization

• Required
• String

This organization for which you which to fetch the last week of closed Pull Requests for. The GITHUB_AUTH_TOKEN provided must have access to the specified organization.

to

• Optional
• String
• Comma separated list of email addresses

If provided, the function will send a copy of the generated list of recently closed Pull Requests to the email addresses specified. Email is sent using SendGrid and requires SENDGRID_API_KEY to be set.

Development

npm run dev

Environmental Variables

See .env.example for a list of environmental variables to set.

Local

For local development, you can use a .env file:

cp .env.example .env

Production

For production, we use Zeit Now's secrets. See now.json for a list of secrets to set.

Deployment

npm run deploy

This assumes you have installed Now locally and logged in.

Reccomendation

Rather than manually checking the endpoint for the list of recently closed Pull Requests, we suggest leveraging EasyCron to periodically hit you Now endpoint with a to query paramter to send yourself the list via email on your own schedule.

weekly-summary-cron-with-now's Issues

Should this be re-written as a GitHub action?

Writing this as a GitHub action could allow it to be run on a schedule without having to leverage something like easycron.

Since this pulls in data from GitHub, it's probably safe to tie it to running on GitHub.

It also looks like using the @actions/github package could allow for API access to already be granted to people that set up the task (also meaning we'd need to change how we use https://github.com/tmr08c/weekly-summary-typescript).

Rather than sending an email, it could create an Issue (maybe we can leverage this action). This would reduce external dependencies.

Fix sending to multiple users

Currently, sending to multiple users doesn't work.

We are setting the to to a comma-separated string, but the packages wants an array.

We should update the code for setting to to be an array and update the README.