Jakarta Data 1.0

[KyleAure]

Specification PR template

When creating a specification project release review, create PRs with the content defined as follows.

Include the following in the PR:

• A directory in the form wombat/x.y where x.y is the release major.minor version, and the directory contains the following.
• Specification PDF in the form of jakarta-wombat-spec-x.y.pdf
• Specification HTML in the form of jakarta-wombat-spec-x.y.html
• A specification page named _index.md following the template at:
  https://github.com/jakartaee/specification-committee/blob/master/spec_page_template.md
• For a Progress Review, that sufficient progress has been made on a Compatible Implementation and TCK, to ensure that the spec is implementable and testable.
• For a Release Review, a summary that a Compatible Implementation is complete, passes the TCK, and that the TCK includes sufficient coverage of the specification. The TCK users guide MUST include the instructions to run the compatible implementations used to validate the release.
  Instructions MAY be by reference.
  • Updated release record - https://jakarta.ee/specifications/data/1.0/
  • Generated IP Log
  • Email to PMC - https://projects.eclipse.org/projects/ee4j.data/reviews/1.0-release-review
  • Start release review by emailing EMO
• The URL of the OSSRH staging repository for the api, javadoc:
  - https://jakarta.oss.sonatype.org/content/repositories/jakartadata-1023/
• The URL of the staging directory on downloads.eclipse.org for the proposed EFTL TCK binary:
  - Staged: https://download.eclipse.org/ee4j/data/jakartaee11/staged/eftl/
  - Promoted: https://download.eclipse.org/ee4j/data/jakartaee11/promoted/eftl/
• The URL of the compatibility certification request issue:
  - Persistence (standalone): [Certification]: Hibernate 6.6.0.X Jakarta Data 1.0 data#714
  - Persistence (platform) : [Certification]: Compatibility certification request for Open Liberty 24.0.0.6-beta for Jakarta Data 1.0 (of Jakarta EE 11) data#741
• Specification JavaDoc in the wombat/x.y/apidocs directory.
  If desired, an optional second PR can be created to contain just the JavaDoc in the apidocs directory.

Note: If any item does not apply, check it and mark N/A below it.

[netlify]

✅ Deploy Preview for jakartaee-specifications ready!

Name	Link
🔨 Latest commit	5648f70
🔍 Latest deploy log	https://app.netlify.com/sites/jakartaee-specifications/deploys/664f480c091da60008db405a
😎 Deploy Preview	https://deploy-preview-737--jakartaee-specifications.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[mtdelgadoa]

Hello all,
the EMO is trying to avoid duplication of release records, so we will be providing our feedback and comments related to this release directly here.

EMO REVIEW CHECKLIST

@Emily-Jiang while evaluating your project IP I've found a couple of issues:
https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/?sort=due_date&state=opened&search=ee4j.data&first_page_size=20

Hopefully, they will be solved soon.
We strongly suggest projects integrate the use of the Eclipse Dash License Tool into their builds.
Update: IP issues were closed. Nothing left to do.

EDP Review status: COMPLETED

EMO review checklist

PMI record: https://projects.eclipse.org/projects/ee4j.data/reviews/1.0-release-review

EF Specification Process

• Spec Committee Ballot completed

Intellectual Property Management

• 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

General:

• Project is operating within the mission and scope defined in its top-level project’s charter
• Project is operating within the bounds of its own scope
• Project is operating in an open and transparent manner
• Overall the project is operating according to the Eclipse Development Process.

Things to check:

• Communication channels advertised
• Advertised communication channels used
• Committers are responding to questions
• Committers are responding to issues
• Committers are responding to pull/merge/review requests

Branding and Trademarks
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)

• 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.)

[Emily-Jiang]

Mentor Spec Review Checklist

1. Spec PR

• PR uses template
• Directory of form {spec}/x.y
• PDF of form jakarta-{spec}-spec-x.y.pdf ("-spec" preferred but not required)
• HTML of form jakarta-{spec}-spec-x.y.html ("-spec" preferred but not required)
• Index page {spec}/x.y/_index.md following template
• Index page {spec}/_index.md following template
• No other files (e.g., no jakarta_ee_logo_schooner_color_stacked_default.png)
• Staging repository link of the form https://jakarta.oss.sonatype.org/content/repositories/staging/jakarta/{spec}/jakarta.{spec}-api/x.y.z/
• EFTL TCK link of the form http://download.eclipse.org/.../+.zip
• Compatibility certification link of the form https://github.com/eclipse-ee4j/{project}/#{issue}
• N/A (Optional) Second PR for just apidocs

2. _index.md

• Link to project release plan of the form https://projects.eclipse.org/projects/ee4j.{spec}/releases/x.y/plan
• Link to spec pdf
• Link to spec html
• Link to apidocs
• Link to final TCK download zip file of the form https://download.eclipse.org/jakartaee/{spec}/x.y/*{spec}-tck-x.y.z.zip (The folder path is required, the file name pattern is preferred.)
• Link to API jar file of the form https://search.maven.org/artifact/jakarta.{spec}/jakarta.{spec}-api/x.y.z/jar
• Name of and link to at least one Compatible Implementation
• Review summary statement to ensure it has been updated to reflect the work accomplished and does not contain proposal statements as might be found in Plan Review statement.

3. javadocs

• Footer contains Eclipse copyright and link to license
• ESFL license is included, usually as doc-files/speclicense.html
• no META-INF directory in PR
• javadocs-jar artifact matches apidocs (optional for this release)

4. Spec PDF

• Correct spec title
• Version number of the form x.y, not x.y.z
• Correct Eclipse copyright line
• No DRAFT or SNAPSHOT
• Correct Logo

5. Spec HTML

• Same as PDF

6. TCK zip file

• README file (optional for this release)
• EFTL license file, preferably named LICENSE.md
• User's Guide (or equivalent documentation)
• How to test the Compatible Implementation(s) listed in _index.md above with the TCK (may be in UG)

7. TCK User's Guide (or equivalent documentation)

• Software requirements listed
• Installation and configuration described
• How to run tests
• Where to file challenges

8. Compatibility certification request

• Request follows template
• SHA-256 fingerprint matches staged TCK zip file
• Request issue has certification label.

9. TCK results summary

• Page is hosted by Compatible Implementation project
• Includes all information from certification request
• Summary includes number of tests passed, failed, errors
• SHA-256 fingerprint matches staged TCK zip file on cert request

10. If a Release Review is required, the specification project team contacts the EMO to initiate the review by sending an email to [email protected].
    (A Release Review is not required if the current release is a Service Release based on a previously successful Major or Minor
    release as indicated by a release record on the project's Releases page, e.g., the Jakarta Servlet releases page.)

    • An issue will be created by the EMO to track the release review.
    • The specification project team requests approval for the release from the PMC by sending an email to [email protected].
    • The specification project team then delivers an IP Log to the IP Team for their review as described in https://www.eclipse.org/projects/handbook/#pmi-commands-iplog.

11. Update Jakarta EE API jar

• Update the Jakarta EE API jar by submitting a PR to the jakartaee-api project that updates the version number of your API jar file.

[Emily-Jiang]

Mentor review comments:

• PDF and HTML of form jakarta-{spec}-spec-x.y.pdf

The addendum doc uses the name jakarta-method-name-query-1.0.pdf. Please update to jakarta-data-addendum-1.0.pdf and .html or merge the content into the parent doc.

[Emily-Jiang]

In the PR template, there are a couple of TODOs, which made this PR incomplete. If it is required, please provide them. If not, please delete the TODOs @KyleAure

[Emily-Jiang]

@KyleAure The TCK license needs to use EFTCK v1.1. The file should be License.md not license.txt. You can find the license here.

[KyleAure]

@Emily-Jiang I've opened a PR against data to fix the TCK-Distribution license to version 1.1 here: jakartaee/data#745

The link you provided to the license document has a copy of the license in HTML and AsciiDoc versions. I replaced license.txt with license.adoc which should be consistent with the requirements.
@edbratt - is currently in the process of asking if we need to make this update now or if it can wait for a service/major release because the same issue exists in Concurrency.

[Emily-Jiang]

Minor comment on TCK user guide: In the section 6, in the table, there are core, web, full, it would be great if you use the proper name: Core Profile, Web Profile and Platform.

[KyleAure]

@Emily-Jiang I have created an issue to do this: jakartaee/data#746
This requires more than a documentation update since the documentation is bound to actual code in the TCK that uses the colloquialism full profile

[Emily-Jiang]

@Emily-Jiang I've opened a PR against data to fix the TCK-Distribution license to version 1.1 here: jakartaee/data#745

The link you provided to the license document has a copy of the license in HTML and AsciiDoc versions. I replaced license.txt with license.adoc which should be consistent with the requirements. @edbratt - is currently in the process of asking if we need to make this update now or if it can wait for a service/major release because the same issue exists in Concurrency.

We discussed on the Jakarta EE spec committee call. From now on, all new spec releases need to use the v1.1.

[KyleAure]

From now on, all new spec releases need to use the v1.1.

@Emily-Jiang From now on... does that mean EE 11 or EE 12?

[Emily-Jiang]

@Emily-Jiang I've opened a PR against data to fix the TCK-Distribution license to version 1.1 here: jakartaee/data#745

The link you provided to the license document has a copy of the license in HTML and AsciiDoc versions. I replaced license.txt with license.adoc which should be consistent with the requirements. @edbratt - is currently in the process of asking if we need to make this update now or if it can wait for a service/major release because the same issue exists in Concurrency.

I double checked the minutes from Jakarta EE Spec Committee meetings. Here is the latest statement regarding the license version requirement. Using TCK License v1.1 is encouraged but not mandatory. Since updating the tck jar causes CCRs to be redone, I am happy for this project to use v1.0 for this release. Any future releases must update the license to v1.1.

[Emily-Jiang]

@Emily-Jiang I have created an issue to do this: jakartaee/data#746 This requires more than a documentation update since the documentation is bound to actual code in the TCK that uses the colloquialism full profile

It is okay to have it corrected in the next release as you cannot easily release another TCK jar without a big delay.

[Emily-Jiang]

On ballot completion, the specification committee mentor:

• adds this final checklist to the main PR.
• adds the approved label to the PRs, and sends out the Ballot Summary per this template to the public Jakarta EE Specification Committee email list
• calculates the staged EFTL TCK signature and promotes it to the committee download area
  using the https://ci.eclipse.org/jakartaee-spec-committee/job/promote-release/ job. Manually editing the jenkins Build Information will help identify the build (ie. Mail 2.0 or CDI 3.0).
• merges the specification (and apidocs) PRs, ensuring the "date:" field in the _index.md file has an appropriate value to allow publishing.
• updates the specification page with the ballot results. This is normally done via a separate PR that should be reviewed, approved, and merged.
• notifies the EMO of the ballot results by email to [email protected]. Just forward the ballot summary note sent earlier to the public Spec Committee email list.
• creates an issue in the specification project that includes the following checklist for the specification project team:
  Data 1.0 final release tasks data#759