rollup-and-away

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

rollup-and-away

(★ 15)

Declarative template-based building blocks for generating Rollup reports, including AI summaries

rollup-and-away Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Rollup and Away

Rollup and Away is an automated reporting assistant that can gather GitHub data from Issues, Discussions, Project Views (and more!) and template it into draft reports. Designed for project managers and team leads who want to reduce repetitive reporting work while preserving essential human judgment.

Built with TypeScript for GitHub Actions workflows, although a CLI is available for testing.

**Features:**
- Declarative templates that define what to pull without worrying about extraction details
- GitHub Projects integration, to plug into existing PM workflows
- Update detection using strategies such as searching for Markdown Headers, HTML comments, fenced HTML blocks, or bolded text
- Custom AI prompts / models for summarization ([supports Models from the GitHub Marketplace](https://github.com/marketplace/models))
- Transparent context window visibility for debugging and corrections
- Ability to send Slack DMs to Issues assignees / Discussion authors. Useful for reminding assignees to add updates.

**Limitations:**
- As the tool is in Beta, it lacks tests and exhaustive API documentation
- Generates drafts that require human review. As with all AI summaries, the output will not be perfect.
- The Slack DM feature will only work in some Slack workspaces, even with a working token. This is because detecting Slack users depends on the assumption the Slack email stem is identical to the GitHub username.

**Current Status:** Active beta development, used in production by internal GitHub teams.

**Goals:** This project aims to eliminate repetitive copy-paste work in status reporting without trying to remove the tasks that require human judgment. It's designed to be portable and flexible, unlike the bespoke one-off solutions which usually fill this niche.

## Background

This project grew out of a few reporting experiments by @amyryanmanny on the TPM Flex / Synapse Team. From my experience writing reporting automations, this is the exact tool I wish I had when I started.

### What People Say

Our Dogfooders who have used Rollup and Away report saving 30+ minutes per week on routine reports, and 1.5+ hours on comprehensive weekly reviews. Even in cases where the time saved is negligible, they say it results in a higher quality report. The automation is also portable, making handoffs easier.

### Roadmap

Roadmap and Milestones coming soon to this repo, as we open source the tool, and migrate our existing project tracking issues.

See [Issues](https://github.com/github/rollup-and-away/issues) to open an issue.

## Usage

For detailed instructions and examples to set up the Actions in your repo (no IDE required), check out the [complete setup guide](https://github.com/github/rollup-and-away/discussions/2).

### Requirements

- Bun
- Node
- Some GitHub Actions environment, and a GitHub API token

### Contributing

We welcome PRs! Please read the [Contribution / Dev Guide](https://github.com/github/rollup-and-away/blob/main/CONTRIBUTING.md) before submitting changes.

Have ideas for improving Rollup and Away? [Submit a feature request](https://github.com/github/rollup-and-away/issues/new).

## License

This project is licensed under the terms of the MIT open source license. Please refer to the [LICENSE](./LICENSE) file for the full terms.

## Maintainers

See [CODEOWNERS](./CODEOWNERS) for the current maintainer list.

## Support

- **📚 Documentation**: Browse [discussions](https://github.com/github/rollup-and-away/discussions) for tips and examples.
- **📋 Bug Reports**: Document [issues](https://github.com/github/rollup-and-away/issues).

## Acknowledgements

Thanks to all the Dogfooders who provided (and continue to provide) feedback during development, and shared their time savings results.

rollup-and-away

rollup-and-away Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

rollup-and-away

rollup-and-away Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README