https://github.com/cutenode/retro-weekly

template repository for retrogen running weekly to generate retrospectives for open source projects
https://github.com/cutenode/retro-weekly

Last synced: about 1 year ago
JSON representation

template repository for retrogen running weekly to generate retrospectives for open source projects

• Host: GitHub
• URL: https://github.com/cutenode/retro-weekly
• Owner: cutenode
• License: mit
• Created: 2022-04-18T22:26:33.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2025-06-01T19:59:54.000Z (about 1 year ago)
• Last Synced: 2025-06-02T05:53:40.654Z (about 1 year ago)
• Language: JavaScript
• Size: 706 KB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# retro-weekly

This repository is a template that can be cloned 1:1 (with some slight alterations of configurations) to generate weekly retros for your GitHub organization or for a specific user. It implements [retrogen](https://github.com/cutenode/retrogen), so if you care about the underlying JavaScript you should look there.

# Usage

You've got two options:

- Use this repository as a template repository for your own project.

- Use the code in this repository as "inspiration" for your own implementation of retrogen.

To make this work for your organization, you'll need to change one thing and might want to change a few others:

- You'll **need** to change the "organization" variable in `generate.js` to your organization's GitHub name. This can also be a username.

- You have the option to change the date range in `generate.js` to something more appropriate for your organization. This is simply the Luxon `DateTime` API. See [the #minus](https://moment.github.io/luxon/api-docs/index.html#datetimeminus) docs for more information.

  - If you do change this, you'll also want to update the cron settings in [`run.yml`](./.github/workflows/run.yml).

- You have the option to change some of the configuration around the generated PR in [`run.yml`](./.github/workflows/run.yml)