The Repo Recap Writer is a simple command line tool to help you write an automated summary of the latest pull requests and issues in your repository. It generates Markdown to be copy and pasted, and you can use that Markdown to publish a new post on dev.to.
There's a lot of general purposing work to be done. This originally started as a bit of a side project, and most of it is built with hard-coded solutions. Since this was made by me (Andy Zhao) to automate my own workflow, you can also consider me the maintainer of this project.
This tool is essentially a command line tool/script, meant to be run locally. To get up and running:
- Clone the repository.
- Create two files in the folder:
environment.rb: This is where you store your environment variables. You can copy over the sample from:environment_sample.rbspecial_usernames.rb: This is for any GitHub usernames that are not the same on dev.to. This allows you to link properly to people's dev.to profiles. You can copy over the sample from:special_usernames_sample.rb
- Fill out the environment variables in
environment.rband add any usernames tospecial_usernames.rb. - Run the repo recap:
ruby repo_recap_writer.rb- Once the process is complete, you should see an output that you can copy and paste into https://dev.to/new. There's a current limitation in that you must be using the v1 editor.
It's a pretty small project, so contributing should be pretty straightforward. Feel free to make a pull request to help out with making this more general purpose or create issues if you have any questions or comments.
A simple outline/roadmap will be up soon.
Thanks for checking this project out!