{"id":22199893,"url":"https://github.com/betagouv/deliverable","last_synced_at":"2026-04-30T00:34:30.232Z","repository":{"id":185070548,"uuid":"656382353","full_name":"betagouv/deliverable","owner":"betagouv","description":"CLI tool to generate your project deliverables from your Github repositories.","archived":false,"fork":false,"pushed_at":"2023-07-20T16:41:00.000Z","size":11643,"stargazers_count":2,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-30T02:44:12.428Z","etag":null,"topics":["automation","cli","deliverable","deliverables","github"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/betagouv.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-06-20T20:56:32.000Z","updated_at":"2023-06-21T13:19:38.000Z","dependencies_parsed_at":"2023-08-01T01:15:58.653Z","dependency_job_id":null,"html_url":"https://github.com/betagouv/deliverable","commit_stats":null,"previous_names":["betagouv/deliverable"],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/betagouv%2Fdeliverable","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/betagouv%2Fdeliverable/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/betagouv%2Fdeliverable/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/betagouv%2Fdeliverable/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/betagouv","download_url":"https://codeload.github.com/betagouv/deliverable/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245372221,"owners_count":20604489,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["automation","cli","deliverable","deliverables","github"],"created_at":"2024-12-02T15:18:43.779Z","updated_at":"2026-04-30T00:34:30.197Z","avatar_url":"https://github.com/betagouv.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ch1 align=\"center\"\u003eDeliverable\u003c/h1\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca aria-label=\"Go to the latest Github release\" href=\"https://github.com/betagouv/deliverable/releases\"\u003e\n    \u003cimg alt=\"Latest GitHub release version including pre-releases\" src=\"https://img.shields.io/github/v/release/betagouv/deliverable?include_prereleases\u0026sort=semver\u0026style=for-the-badge\u0026labelColor=000\"\u003e\n  \u003c/a\u003e\n  \u003ca aria-label=\"Open the AGPL-3.0 license\" href=\"https://github.com/betagouv/deliverable/blob/main/LICENSE\"\u003e\n    \u003cimg alt=\"AGPL-3.0 license\" src=\"https://img.shields.io/github/license/betagouv/deliverable?style=for-the-badge\u0026labelColor=000\"\u003e\n  \u003c/a\u003e\n  \u003ca aria-label=\"Go to the main branch workflow history\" href=\"https://github.com/betagouv/deliverable/actions?query=branch%3Amain+workflow%3AUnit\"\u003e\n    \u003cimg alt=\"Latest workflow status for main branch\" src=\"https://img.shields.io/github/actions/workflow/status/betagouv/deliverable/main.yml?branch=main\u0026label=Build\u0026style=for-the-badge\u0026labelColor=000\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n---\n\nWhat's the most annoying obligation in a developer life other than accounting?\n\nWriting your project deliverables!\n\nYou can now de-li-ver (ha-ha-ha) yourself by automatizing this task with **Deliverable**, a CLI tool that does (most of)\nthe job for you!\n\n**Deliverable** parses either your fancy Github release descriptions, or your pull request subjects, or your\nwell-written commit messages (which you should ALWAYS have!) from your main branch to generate a well-formatted Markdown\ndocument as well as a DOCX one.\n\nAnd if you don't have any of those, maybe you should start improving your continuous development practices 😉.\n\n---\n\n- [Install](#install)\n- [Usage](#usage)\n  - [Advice](#advice)\n- [Demo](#demo)\n- [Features](#features)\n- [Contribute](#contribute)\n\n---\n\n## Install\n\nSince **Deliverable** generates a Markdown document, installing Pandoc is required if you want to subsequently convert\nit to a DOCX document so you can easily copy/paste it into LibreOffice, OpenOffice, Google Drive, Word, etc.\n\nIf **Deliverable** detects the `pandoc` command, it will automatically use it to convert the generated Markdown document\ninto a DOCX one.\n\n1. [Install Pandoc](https://pandoc.org/installing.html).\n2. [Download your OS standalone binary from the latest release](https://github.com/betagouv/deliverable/releases).\n3. Under Linux and macOS, you may need to make the binary executable via `chmod +x deliverable-...`.\n\nOr if you prefer to clone this repo, you can just run it via `yarn \u0026\u0026 yarn setup \u0026\u0026 yarn start`.\n\n## Usage\n\nJust run the binary in a CLI (i.e.: `./deliverable-linux-x64-1.0.4`) and you will be prompted to setup your options.\n\n### Advice\n\n\u003e It's generally better to use either **Releases History** or **Merged Pull Requests History**,\u003cbr /\u003e rather than\n\u003e **Commit Messages History**, since the latter is more verbose and less readable.\n\n## Demo\n\n![Demo](./docs/demo.gif)\n\n## Features\n\n_Unchecked features are not yet implemented._\n\n**Deliverable** can:\n\n- [x] Generate a well-formatted Markdown and DOCX document from your:\n  - [x] Releases History\n  - [ ] Merged Pull Requests History\n  - [x] Commits Messages History\n- [x] Retrieve your history between specific dates\n- [ ] Handle multiple repositories\n- [x] Automatically translate your deliverable from English to another language\n- [x] Be used via standalone binaries available for Linux, macOS and Windows\n\n## Contribute\n\nGo to the [CONTRIBUTE.md](./CONTRIBUTE.md) file to learn how to contribute to this project (it's easy!).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbetagouv%2Fdeliverable","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbetagouv%2Fdeliverable","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbetagouv%2Fdeliverable/lists"}