Skip to content

Integrate with GitHub releases #10

Open
@nedtwigg

Description

@nedtwigg

It would be useful to turn GitHub releases into a changelog, and vice-versa. Our Changelog.java would be helpful for this. In pseudocode:

import com.diffplug.spotless.changelog.Changelog;
import com.diffplug.spotless.changelog.Changelog.VersionEntry;

// this won't compile, but the main APIs are already present
Changelog empty = new Changelog("## [Unreleased]\n");
Changelog withGitHub = empty.withMutatedVersions(versions -> {
  for (GitHubRelease r : GitHubApi.releases()) {
    versions.add(VersionEntry.versionDate(r.version(), r.date())
      .setChanges(r.releaseNotes()));
  }
})
System.out.println(withGitHub.toStringUnix());

We'd be happy to merge any PRs which add GitHub integration (in either direction) into spotless-changelog-lib. Once that has been accomplished, we'd be happy to merge any PRs which add GitHub-related functionality into the gradle plugin.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requestpr-welcomeWe doesn't plan to build, but are happy to merge

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions