Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anchore/chronicle
a fast changelog generator sourced from PRs and Issues
https://github.com/anchore/chronicle
changelog changelog-generator github golang hacktoberfest
Last synced: 3 days ago
JSON representation
a fast changelog generator sourced from PRs and Issues
- Host: GitHub
- URL: https://github.com/anchore/chronicle
- Owner: anchore
- License: apache-2.0
- Created: 2021-09-30T19:52:14.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T13:04:04.000Z (15 days ago)
- Last Synced: 2024-10-29T15:21:29.639Z (15 days ago)
- Topics: changelog, changelog-generator, github, golang, hacktoberfest
- Language: Go
- Homepage:
- Size: 405 KB
- Stars: 52
- Watchers: 15
- Forks: 5
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# chronicle
[](https://github.com/anchore/chronicle/actions/workflows/validations.yaml)
[](https://goreportcard.com/report/github.com/anchore/chronicle)
[](https://github.com/anchore/chronicle/releases/latest)
[](https://github.com/anchore/chronicle)
[](https://github.com/anchore/chronicle/blob/main/LICENSE)
[](https://anchore.com/slack)
**A fast changelog generator that sources changes from GitHub PRs and issues, organized by labels.**
Create a changelog from the last GitHib release until the current git HEAD tag/commit for the git repo in the current directory:
```bash
chronicle
```
Create a changelog with all changes from v0.16.0 until current git HEAD tag/commit for the git repo in the current directory:
```bash
chronicle --since-tag v0.16.0
```
Create a changelog between two specific tags for a repo at the given path
```bash
chronicle --since-tag v0.16.0 --until-tag v0.18.0 ./path/to/git/repo
```
Create a changelog and guess the release version from the set of changes in the changelog
```bash
chronicle -n
```
Just guess the next release version based on the set of changes (don't create a changelog)
```bash
chronicle next-version
```
## Installation
```bash
curl -sSfL https://raw.githubusercontent.com/anchore/chronicle/main/install.sh | sh -s -- -b /usr/local/bin
```
...or, you can specify a release version and destination directory for the installation:
```
curl -sSfL https://raw.githubusercontent.com/anchore/chronicle/main/install.sh | sh -s -- -b
```
## Configuration
Configuration search paths:
- `.chronicle.yaml`
- `.chronicle/config.yaml`
- `~/.chronicle.yaml`
- `/chronicle/config.yaml`
### Default values
Configuration options (example values are the default):
```yaml
# the output format of the changelog
# same as -o, --output, and CHRONICLE_OUTPUT env var
output: md
# suppress all logging output
# same as -q ; CHRONICLE_QUIET env var
quiet: false
# all logging options
log:
# use structured logging
# same as CHRONICLE_LOG_STRUCTURED env var
structured: false
# the log level
# same as CHRONICLE_LOG_LEVEL env var
level: "warn"
# location to write the log file (default is not to have a log file)
# same as CHRONICLE_LOG_FILE env var
file: ""
# guess what the next release version is based on the current version and set of changes (cannot be used with --until-tag)
# same as --speculate-next-version / -n ; CHRONICLE_SPECULATE_NEXT_VERSION env var
speculate-next-version: false
# override the starting git tag for the changelog (default is to detect the last release automatically)
# same as --since-tag / -s ; CHRONICLE_SINCE_TAG env var
since-tag: ""
# override the ending git tag for the changelog (default is to use the tag or commit at git HEAD)
# same as --until-tag / -u ; CHRONICLE_SINCE_TAG env var
until-tag: ""
# if the current release version is < v1.0 then breaking changes will bump the minor version field
# same as CHRONICLE_ENFORCE_V0 env var
enforce-v0: false
# the title used for the changelog
# same as CHRONICLE_TITLE
title: Changelog
# all github-related settings
github:
# the github host to use (override for github enterprise deployments)
# same as CHRONICLE_GITHUB_HOST env var
host: github.com
# do not consider any issues or PRs with any of the given labels
# same as CHRONICLE_GITHUB_EXCLUDE_LABELS env var
exclude-labels:
- duplicate
- question
- invalid
- wontfix
- wont-fix
- release-ignore
- changelog-ignore
- ignore
# consider merged PRs as candidate changelog entries (must have a matching label from a 'github.changes' entry)
# same as CHRONICLE_GITHUB_INCLUDE_PRS env var
include-prs: true
# consider closed issues as candidate changelog entries (must have a matching label from a 'github.changes' entry)
# same as CHRONICLE_GITHUB_INCLUDE_ISSUES env var
include-issues: true
# issues can only be considered for changelog candidates if they have linked PRs that are merged (note: does NOT require github.include-issues to be set)
# same as CHRONICLE_GITHUB_ISSUES_REQUIRE_LINKED_PRS env var
issues-require-linked-prs: false
# list of definitions of what labels applied to issues or PRs constitute a changelog entry. These entries also dictate
# the changelog section, the changelog title, and the semver field that best represents the class of change.
# note: cannot be set via environment variables
changes: [......] # See "Default GitHub change definitions" section for more details
```
### Default GitHub change definitions
The `github.changes` configurable is a list of mappings, each that take the following fields:
- `name`: _[string]_ singular, lowercase, hyphen-separated (no spaces) name that best represents the change (e.g. "breaking-change", "security", "added-feature", "enhancement", "new-feature", etc).
- `title`: _[string]_ title of the section in the changelog listing all entries.
- `semver-field`: _[string]_ change entries will bump the respective semver field when guessing the next release version. Allowable values: `major`, `minor`, or `patch`.
- `labels`: _[list of strings]_ all issue or PR labels that should match this change section.
The default value for `github.changes` is:
```yaml
- name: security-fixes
title: Security Fixes
semver-field: patch
labels:
- security
- vulnerability
- name: added-feature
title: Added Features
semver-field: minor
labels:
- enhancement
- feature
- minor
- name: bug-fix
title: Bug Fixes
semver-field: patch
labels:
- bug
- fix
- bug-fix
- patch
- name: breaking-feature
title: Breaking Changes
semver-field: major
labels:
- breaking
- backwards-incompatible
- breaking-change
- breaking-feature
- major
- name: removed-feature
title: Removed Features
semver-field: major
labels:
- removed
- name: deprecated-feature
title: Deprecated Features
semver-field: minor
labels:
- deprecated
- name: unknown
title: Additional Changes
```