Skip to content

Add palantir-java-format-action into the README as a third-party integration#1706

Open
abashev wants to merge 3 commits into
palantir:developfrom
abashev:add-github-action-readme
Open

Add palantir-java-format-action into the README as a third-party integration#1706
abashev wants to merge 3 commits into
palantir:developfrom
abashev:add-github-action-readme

Conversation

@abashev

@abashev abashev commented Jul 3, 2026

Copy link
Copy Markdown

Before this PR

The README lists several ways to use palantir-java-format, including the Eclipse and IntelliJ plugins, the Gradle plugin, and Spotless integration.

However, it does not mention third-party GitHub Actions that wrap palantir-java-format for CI formatting checks.

After this PR

Document palantir-java-format-action as a third-party integration.

palantir-java-format-action is an open-source GitHub Action that checks Java code formatting in CI using the palantir-java-format native binary, without requiring Java, Maven, or Gradle on the runner. By default it only checks files changed in a pull request or push, and caches the native binary between runs.

This makes it easier for users who want a lightweight formatting check in GitHub Actions CI to discover an existing integration path.

Possible downsides?

This adds a link to a third-party project that is not maintained by Palantir.

@changelog-app

changelog-app Bot commented Jul 3, 2026

Copy link
Copy Markdown

Generate changelog in changelog/@unreleased

Type (Select exactly one)

  • Feature (Adding new functionality)
  • Improvement (Improving existing functionality)
  • Fix (Fixing an issue with existing functionality)
  • Break (Creating a new major version by breaking public APIs)
  • Deprecation (Removing functionality in a non-breaking way)
  • Migration (Automatically moving data/functionality to a new system)

Description

Add palantir-java-format-action into the README as a third-party integration

Check the box to generate changelog(s)

  • Generate changelog entry

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant