https://github.com/betagouv/deliverable

CLI tool to generate your project deliverables from your Github repositories.
https://github.com/betagouv/deliverable

automation cli deliverable deliverables github

Last synced: about 2 months ago
JSON representation

CLI tool to generate your project deliverables from your Github repositories.

• Host: GitHub
• URL: https://github.com/betagouv/deliverable
• Owner: betagouv
• License: agpl-3.0
• Created: 2023-06-20T20:56:32.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-07-20T16:41:00.000Z (almost 3 years ago)
• Last Synced: 2025-01-30T02:44:12.428Z (over 1 year ago)
• Topics: automation, cli, deliverable, deliverables, github
• Language: TypeScript
• Homepage:
• Size: 11.1 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          


  
Deliverable




  

    

  

  

    

  

  

    

  



---

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 😉.

---

- [Install](#install)

- [Usage](#usage)

  - [Advice](#advice)

- [Demo](#demo)

- [Features](#features)

- [Contribute](#contribute)

---

## Install

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.

1. [Install Pandoc](https://pandoc.org/installing.html).

2. [Download your OS standalone binary from the latest release](https://github.com/betagouv/deliverable/releases).

3. 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`.

## Usage

Just run the binary in a CLI (i.e.: `./deliverable-linux-x64-1.0.4`) and you will be prompted to setup your options.

### Advice

> 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.

## Demo

![Demo](./docs/demo.gif)

## Features

_Unchecked features are not yet implemented._

**Deliverable** can:

- [x] Generate a well-formatted Markdown and DOCX document from your:

  - [x] Releases History

  - [ ] Merged Pull Requests History

  - [x] Commits Messages History

- [x] Retrieve your history between specific dates

- [ ] Handle multiple repositories

- [x] Automatically translate your deliverable from English to another language

- [x] Be used via standalone binaries available for Linux, macOS and Windows

## Contribute

Go to the [CONTRIBUTE.md](./CONTRIBUTE.md) file to learn how to contribute to this project (it's easy!).