What's the most annoying obligation in a developer life other than accounting?
Writing your project deliverables!
You can now de-li-ver (ha-ha-ha) yourself by automatizing this task with Deliverable, a CLI tool that does (most of) the job for you!
Deliverable parses either your fancy Github release descriptions, or your pull request subjects, or your well-written commit messages (which you should ALWAYS have!) from your main branch to generate a well-formatted Markdown document as well as a DOCX one.
And if you don't have any of those, maybe you should start improving your continuous development practices 😉.
Since Deliverable generates a Markdown document, installing Pandoc is required if you want to subsequently convert it to a DOCX document so you can easily copy/paste it into LibreOffice, OpenOffice, Google Drive, Word, etc.
If Deliverable detects the pandoc command, it will automatically use it to convert the generated Markdown document
into a DOCX one.
- Install Pandoc.
- Download your OS standalone binary from the latest release.
- Under Linux and macOS, you may need to make the binary executable via
chmod +x deliverable-....
Or if you prefer to clone this repo, you can just run it via yarn && yarn setup && yarn start.
Just run the binary in a CLI (i.e.: ./deliverable-linux-x64-1.0.4) and you will be prompted to setup your options.
It's generally better to use either Releases History or Merged Pull Requests History,
rather than Commit Messages History, since the latter is more verbose and less readable.
Unchecked features are not yet implemented.
Deliverable can:
- Generate a well-formatted Markdown and DOCX document from your:
- Releases History
- Merged Pull Requests History
- Commits Messages History
- Retrieve your history between specific dates
- Handle multiple repositories
- Automatically translate your deliverable from English to another language
- Be used via standalone binaries available for Linux, macOS and Windows
Go to the CONTRIBUTE.md file to learn how to contribute to this project (it's easy!).