https://github.com/pbrisbin/r2cl

Generate CHANGLOG.md from Releases
https://github.com/pbrisbin/r2cl

Last synced: about 2 months ago
JSON representation

Generate CHANGLOG.md from Releases

• Host: GitHub
• URL: https://github.com/pbrisbin/r2cl
• Owner: pbrisbin
• License: mit
• Created: 2024-06-21T13:45:43.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-06-25T18:28:36.000Z (6 months ago)
• Last Synced: 2024-10-09T09:44:14.806Z (3 months ago)
• Language: Haskell
• Homepage:
• Size: 20.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# R2CL

Fetch releases from GitHub and format a full CHANGELOG from their notes.

## Installation

TODO

## Usage

```console

% r2cl --help

Usage: r2cl --repo OWNER/NAME [--default-branch ARG] [--after vX.Y.Z]

            [-u|--update PATH]

Available options:

  --repo OWNER/NAME        Repository to fetch releases for

  --default-branch ARG     Branch to use in Unreleased section (default: "main")

  --after vX.Y.Z           Only generate with versions down to the given version

  -u,--update PATH         Update PATH in place

  -h,--help                Show this help text

```

`$GITHUB_TOKEN` must be set token a token with `read:content` on the repository.

## Examples

Replacing a full `CHANGELOG.md`:

```console

GITHUB_TOKEN=... r2cl --repo foo/bar >CHANGELOG.md

```

## `--update`

If you pass `--update PATH` the content will be written into that file. Where

it's written depends on the presence of pragmas.

If both `` and `` are present, the lines

between them are *replaced* with the content. If only `BEGIN` present, the lines

are *inserted* after it. If neither are present, the lines are *inserted* at the

top of the file. No how it started, after this operation, both `BEGIN` and `END`

pragmas will be present.

## `--after`

If `--after vX.Y.Z` is given, only releases down to that version (exclusive,

beginning with latest) are included. This allows you to main content for older

versions manually, while automatically writing in content for newer versions

(presumably when more details and/or consistent release notes began).

---

[CHANGELOG](./CHANGELOG.md) | [LICENSE](./LICENSE)