Skip to content

Relocate @API to a stand-alone module #436

Closed
@sbrannen

Description

@sbrannen

Overview

The @API annotation may better serve the community at large if it is moved from junit-platform-commons to a stand-alone module.

Related Issues

Deliverables

  • Refactor the @API annotation so that it has the following attributes:
    • status: Status (used to be value)
    • since: String (version the status was last changed, e.g. "5.0.0", defaults to "")
    • consumers: String[] (list of package patterns for intended consumers, defaults to {"*"})
  • Rename Status constants to align with industry standards for enum constants.
  • Set since attribute across the JUnit 5 code base.
  • ❌ Set consumers attribute across the JUnit 5 code base.
  • Move @API to a stand-alone project on GitHub.
  • Use @API from the @API Guardian project and delete @API from junit-platform-commons.

Metadata

Metadata

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions