MicroProfile 6.1 Specification Review

[Emily-Jiang]

Specification issue template

When creating a specification project release review, create an issue in the MicroProfile-WG repository repo with the content defined as follows.

• Specification name and version
• Add the label Release Review
• Naming conventions for artifacts:
  • Specification PDF in the form of microprofile-project-spec-version.pdf
  • Specification HTML in the form of microprofile-project-spec-version.html
  • project is the microprofile specification short project name (config, health, ...)
  • version is the two digit x.y version of the specification

• The Nexus Staging links (orgeclipsemicroprofile-NNNN where NNNN is the staging repository id) (eg, https://oss.sonatype.org/content/repositories/orgeclipsemicroprofile-NNNN/org/eclipse/microprofile/config/) which contain all the binaries and relevant documentation:
  • Staging Repo
  • Spec PDF
  • Spec HTML
  • [Javadoc](add link) n/a
  • [API Jar](add link) n/a
  • [TCK Jar](add link) n/a

• A link in the Eclipse downloads sections is still available for specs and apidocs:
  • https://download.eclipse.org/microprofile/staging/microprofile-6.1/
  • An apidocs directory containing the javadoc associated with the API jar.

• Summary that a Compatible Implementation is complete, passes the TCK, and that the TCK includes sufficient coverage of the specification.
  • [Compatible Certification Request] (add link of Compatible Certification Request in the corresponding spec repo (e.g. MicroProfile Config)

• Release Review
  • Follow governance process and create/update release record
    • Component Release Record
  • Email to PMC (more info here)
  • Start release review by emailing EMO (more info here)(Track the [bug issue](add link) created by EMO after the email)
  • A member of Steering Committee initiates the ballot by sending an email to [microprofile-wg] (mailto:microprofile-wg@eclipse.org) more info here
  • After the voting has ended, email [microprofile-wg] (mailto:microprofile-wg@eclipse.org) with the ballot result more info here

[mtdelgadoa]

We're updating our release review process by integrating the review checklist directly into your GitHub workflow. This change will enhance our ability to provide more effective feedback within the context of each issue, leading to improved efficiency, collaboration, and the elimination of duplication.

EMO REVIEW

• PMI Review Record: https://projects.eclipse.org/projects/technology.microprofile/reviews/microprofile-6.1-release-review

Intellectual Property Management

To be completed by the EMO.

• All project code has copyright and license headers correctly applied. ** EMO will scan the code at their discretion **
• All distributed third-party content has been vetted by the IP Due Diligence process (i.e., IP Log has been approved)

Open Source Rules of Engagement

• PMC approval on the mailing list

Branding and Trademarks

To be completed by the EMO and PMC.

The following applies when the project has a custom website.

To the best of our knowledge:

• Project content correctly uses Eclipse Foundation trademarks
• Project content (code and documentation) does not violate trademarks owned by other organizations

Things to check:

• Project website uses the project's formal name in first and all prominent references
• Project website includes a trademark attribution statement
• Project website footers contain all necessary elements

Legal Documentation

Required files:

• License files in all repository roots
• README
• CONTRIBUTING (or equivalent)

Recommended files:

• NOTICES or equivalent you can use the Legal Documentation generator available under committer tools
• CODE_OF_CONDUCT
• SECURITY

See examples for Security file and Code of Conduct.

Required elements:

• ECA is referenced/described

Recommended elements:

• Build instructions provided
• Security policy is described

Metadata (PMI)

To be completed by the EMO

• The formal name, e.g. "Eclipse Foo™", is used in the project title
• The formal name including appropriate marks (e.g, "™") is used in the first mention in the text of the project description, and scope
• The project description starts with a single paragraph that can serve as an executive summary
• Source code repository references are up-to-date
• Download links and information are up-to-date (see EF handbook for more information on how-to do this)
• Communication channels listed in the PMI (i.e. public mailing list, forums, etc.)

[mtdelgadoa]

Please consider adding recommended files (i.e. Code of Conduct and Security) directly in each project repository.

[JanWesterkamp-iJUG]

Transitive CVEs in MP and Jakarta component specs, that are not addressed yet completely:

• https://bugs.eclipse.org/bugs/show_bug.cgi?id=581579
• https://bugs.eclipse.org/bugs/show_bug.cgi?id=581586
• https://bugs.eclipse.org/bugs/show_bug.cgi?id=581580
• https://bugs.eclipse.org/bugs/show_bug.cgi?id=581588

The last two of them are Jakarta related and out of scope here, but might require an additional release when fixed there too.
For details, see MP Parent issue and comment here.

[mtdelgadoa]

The EMO review has concluded successfully. Please continue with your release.

SPec Ballot results: MicroProfile 6.1 Ballot has passed