Skip to content

Document deprecation of SemVerVersionPolicy#1450

Merged
elharo merged 1 commit intoapache:masterfrom
anukalp2804:doc-deprecations-semver-policy
Jan 8, 2026
Merged

Document deprecation of SemVerVersionPolicy#1450
elharo merged 1 commit intoapache:masterfrom
anukalp2804:doc-deprecations-semver-policy

Conversation

@anukalp2804
Copy link
Copy Markdown
Contributor

This PR is part of Issue #1436 – Document Deprecations and improves the
documentation for the deprecated SemVerVersionPolicy.

  • Expanded Javadoc to explain why this policy is deprecated
  • Pointed users to the recommended replacement:
    SemVerMinorDevelopmentVersionPolicy
  • Clarified that the policy is retained only for backward compatibility
    and may be removed in a future version
  • No functional behavior changes
  • Build successfully verified using mvn clean install

Reference: #1436
/cc @elharo

Following this checklist to help us incorporate your
contribution quickly and easily:

  • Your pull request should address just one issue, without pulling in other changes.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Each commit in the pull request should have a meaningful subject line and body.
    Note that commits might be squashed by a maintainer on merge.
  • Write unit tests that match behavioral changes, where the tests fail if the changes to the runtime are not applied.
    This may not always be possible but is a best-practice.
  • Run mvn verify to make sure basic checks pass.
    A more thorough check will be performed on your pull request automatically.
  • You have run the integration tests successfully (mvn -Prun-its verify).

If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.

To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.

Expanded Javadoc to clarify why this policy is deprecated, the recommended replacement (SemVerMinorDevelopmentVersionPolicy), and its future removal intent. Documentation only, no functional changes.
@elharo elharo merged commit 57d6328 into apache:master Jan 8, 2026
11 checks passed
@github-actions github-actions bot added this to the 3.3.2 milestone Jan 8, 2026
@github-actions
Copy link
Copy Markdown

github-actions bot commented Jan 8, 2026

@elharo Please assign appropriate label to PR according to the type of change.

@anukalp2804 anukalp2804 deleted the doc-deprecations-semver-policy branch March 10, 2026 16:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants