Skip to content

Document LSP4J's API policy#921

Merged
jonahgraham merged 1 commit into
eclipse-lsp4j:mainfrom
jonahgraham:api-policy
Nov 19, 2025
Merged

Document LSP4J's API policy#921
jonahgraham merged 1 commit into
eclipse-lsp4j:mainfrom
jonahgraham:api-policy

Conversation

@jonahgraham

@jonahgraham jonahgraham commented Nov 18, 2025

Copy link
Copy Markdown
Contributor

Fixes #873

Note that I want to enforce the policy too via using --error-on-semantic-incompatibility for japicmp, but that doesn't seem to be supported from CLI so I put forward siom79/japicmp#467 and if that is accepted we can automate the missing version bump detection

@jonahgraham jonahgraham requested a review from pisv November 18, 2025 20:02

@pisv pisv left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks! 👍

Assuming that breaking changes shall continue to be documented in the changelog, would it be worth it to explicitly mention it?

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
@jonahgraham

Copy link
Copy Markdown
Contributor Author

Assuming that breaking changes shall continue to be documented in the changelog, would it be worth it to explicitly mention it?

I changed the content of "Published API changes" section to include this information.

@jonahgraham jonahgraham requested a review from pisv November 19, 2025 16:19
@jonahgraham

Copy link
Copy Markdown
Contributor Author

I think this is ready to go. I will leave it for a bit in case anyone else has a comment.

@pisv pisv left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great to me!

@jonahgraham jonahgraham merged commit e28faae into eclipse-lsp4j:main Nov 19, 2025
1 check passed
@jonahgraham jonahgraham deleted the api-policy branch November 19, 2025 21:23
@jonahgraham jonahgraham added this to the 1.0.0 milestone Feb 9, 2026
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.

Document API policy in regards to Semantic Versioning

2 participants