Skip to content

Generate the release notes with git-cliff #355

Description

@jdhughes-dev

The release notes are code.md, the table of programs pymake can build, so a release says nothing about what changed in pymake. The breaking changes in 2.0.0 (the build engine removed, the program database moved to toml, mfusg_gsi renamed to mfusgt, python 3.10 dropped, pydot made optional) had to be written by hand.

flopy generates docs/version_changes.md from the merged pull requests with git-cliff and a cliff.toml, and the release workflow could do the same here for 2.1.0. The pull request title becomes the changelog line, so the conventional commit types the repository already uses are what the configuration would select on.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions