Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/drgarcia1986/changelogger
A cross-platform changelog file generator
https://github.com/drgarcia1986/changelogger
changelog go towncrier
Last synced: 5 days ago
JSON representation
A cross-platform changelog file generator
- Host: GitHub
- URL: https://github.com/drgarcia1986/changelogger
- Owner: drgarcia1986
- License: mit
- Created: 2021-05-22T15:27:20.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-05-30T19:01:24.000Z (over 3 years ago)
- Last Synced: 2024-10-31T19:36:37.011Z (12 days ago)
- Topics: changelog, go, towncrier
- Language: Go
- Homepage:
- Size: 10.7 KB
- Stars: 13
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# changelogger
A changelog file generator heavily inspired on [towncrier](https://github.com/twisted/towncrier).
## Why?
I'm looking for an alternative to towncrier that doesn't require a Python environment,
so I decided to build one with only basic features.
## Install
From source
```
$ go get github.com/drgarcia1986/changelogger
```
Or get the binary from [release](https://github.com/drgarcia1986/changelogger/releases) page.
## How it works?
```
$ changelogger -h
Usage of changelogger:
-dir string
Directory of changelog entries
-path string
Path of the changelog file
-version string
The release version
$ changelogger -dir ./.changelog -path ./CHANGELOG.md -version v1.1.2
```
changelogger will search for files on the directory of changelog entries (flag `-dir`) that contains the follow extensions:
* `.added`
* `.changed`
* `.removed`
* `.fixed`
Each file represents an entry on changelog and the extension defines which session the entry will be added to.
After collecting all entries, changelogger remove the entry file and edit the changelog file (flag `-path`) replacing the placeholder
`[changelogger-notes]::` for the content of the entries with a version header (flag `-version`). F.ex:
```diff
# Changelog
- [changelogger-notes]::
+ [changelogger-notes]::
+
+ ## v0.0.1 (2021-05-22)
+ ### Added
+ * A new cool feature
+
+ ## Removed
+ * The deprecated feature
```