https://github.com/ropes/parakeet

Produce github markdown from squashed git commit oneliners for release notes.
https://github.com/ropes/parakeet

Last synced: about 1 year ago
JSON representation

Produce github markdown from squashed git commit oneliners for release notes.

• Host: GitHub
• URL: https://github.com/ropes/parakeet
• Owner: Ropes
• License: apache-2.0
• Created: 2018-05-29T04:59:34.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2018-05-29T05:25:33.000Z (about 8 years ago)
• Last Synced: 2025-02-08T15:16:52.234Z (over 1 year ago)
• Language: Go
• Size: 10.7 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
Parakeet

--------

Attempting to reduce the suckery of releases accross Github projects. Parakeet foolishly pecks at `git log --oneline` output betweeen git commits to add complete github link to originating Github issues for documentation.

![](https://media.giphy.com/media/ceHKRKMR6Ojao/giphy.gif)

[source](https://giphy.com/gifs/bird-explosion-parakeet-ceHKRKMR6Ojao)

Expects the Github "Squash and Merge" notation as Git log lines: "{hash} {PR title message} {Issue Number}"

## Example

Process the git commit log between two tags, process logs, and dump to clipboard(#yearofthelinuxdesktop).

`git log --oneline tagOld..tagNew | parakeet github.com/ropes/parakeet | xclip`

Output from dumping the example file included in project:

```cat eg.gitlog | ./parakeet https://github.com/ropes/parakeet

[666666e11](https://github.com/ropes/parakeet/commit/666666e11) Guardrails to cache usage refactored [1287](https://github.com/ropes/parakeet/issues/1287)

[131313131](https://github.com/ropes/parakeet/commit/131313131) major refactoring to clean things up. [1302](https://github.com/ropes/parakeet/issues/1302)

```