Skip to content

build: Establish Changelog tracking #63

Open
@radeksimko

Description

@radeksimko

Most HashiCorp tools have a track record of maintaining a decent human-readable change log and we should figure out how to fit that into the workflows here too, so that folks can read what each release contains.

Historically we always/often valued human-crafted change logs, as opposed to fully generated ones, but we can explore if there's any balanced solution between the two, so that e.g. users don't need to decode low-level commit messages or see refactoring or docs commits at all and maintainers are less likely to forget updating the change log.

A change log should be linkable (per version) and ideally decoupled from GitHub releases as we expect LS to be distributed outside of GitHub too at some point per #49

We can also explore what GoReleaser offers https://goreleaser.com/customization/#customize-the-changelog

Metadata

Metadata

Assignees

No one assigned

    Labels

    ciContinuous integration/delivery relatedupstream

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions