Messaging 3.1 release review

[OndroMih]

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
• N/A 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://projects.eclipse.org/projects/ee4j.messaging/releases/3.1.0
  • Generated IP Log - requested generation with due date of 8th March 2022
  • Email to PMC
  • Start release review by emailing EMO
• The URL of the OSSRH staging repository for the api, javadoc:
  https://jakarta.oss.sonatype.org/content/groups/staging/jakarta/jms/jakarta.jms-api/3.1.0/
• The URL of the staging directory on downloads.eclipse.org for the proposed EFTL TCK binary:
  https://download.eclipse.org/ee4j/jakartaee-tck/jakartaee10/promoted/eftl/jakarta-messaging-tck-3.1.0.zip
• The URL of the compatibility certification request issue:
  Compatibility certification request for Eclipse OpenMQ
• Specification JavaDoc in the wombat/x.y/apidocs directory.
  • in a separate PR: Messaging 3.1 - Javadoc #464
  • Preview: https://deploy-preview-464--jakartaee-specifications.netlify.app/specifications/messaging/3.1/apidocs/jakarta.messaging/module-summary.html

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	4e3312c
🔍 Latest deploy log	https://app.netlify.com/sites/jakartaee-specifications/deploys/627d2fd02bc14f0009a0de18
😎 Deploy Preview	https://deploy-preview-455--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 settings.

[OndroMih]

I've noticed that the TCK guide in the ZIP TCK package still sometimes references the older version 3.0. The TCK is part of the jakartaee-tck project. I'll file a PR to fix that but it might take a while until we have a published ZIP artifact for it.

[ivargrimstad]

@jeanouii Have you had the time to look at this? It looks like it has been ready for release review a while...

[jeanouii]

Yes I had some personal issues and haven't been able to look at it before. Catching up and it looks good.

[jeanouii]

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}
• (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 emo@eclipse.org.
    (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 ee4j-pmc@eclipse.org.
    • 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.

[jeanouii]

@OndroMih a couple of issues to fix please

• Looks like it's still using jms-api instead of messaging-api (not a blocker but would be great to not use old names)
• Links to sig and pub at least are broken in the _index.md file
• The date at the top is wrong (2021 instead of 2022)
• The compatible implementation is not listed but on the other hand, we have a weird [Eclipse Vombatidae 9.1.1](https://github.com/eclipse-ee4j/vombatidae) which is not what the CSR is mentioning
• The CSR sha256 does not match what I can compute after downloading the staged TCK which is also different from the one referenced in the jenkins job with the results

[pzygielo]

Just a comment regarding:

• The CSR sha256 does not match what I can compute after downloading the staged TCK which is also different from the one referenced in the jenkins job with the results

---

This is to no surprise, as since TCK was executed (on Mar 2nd), with

*** Date and size: date: 2022-03-02 12:07:01.000000000 +0000, size(b): 14166276        ***

the jakarta-messaging-tck-3.1.0.zip was staged multiple times, and today jakarta-messaging-tck-3.1.0-tckinfo.txt it is

*** Date and size: date: 2022-04-12 08:00:05.000000000 +0000, size(b): 14146244        ***

The sha256 could be considered frozen only after final TCK is frozen/promoted, and it isn't at time of writing.

[alwin-joseph]

Just a comment regarding:

• The CSR sha256 does not match what I can compute after downloading the staged TCK which is also different from the one referenced in the jenkins job with the results

This is to no surprise, as since TCK was executed (on Mar 2nd), with

*** Date and size: date: 2022-03-02 12:07:01.000000000 +0000, size(b): 14166276        ***

the jakarta-messaging-tck-3.1.0.zip was staged multiple times, and today jakarta-messaging-tck-3.1.0-tckinfo.txt it is

*** Date and size: date: 2022-04-12 08:00:05.000000000 +0000, size(b): 14146244        ***

The sha256 could be considered frozen only after final TCK is frozen/promoted, and it isn't at time of writing.

I have stopped the bundle refresh at https://download.eclipse.org/ee4j/jakartaee-tck/jakartaee10/staged/eftl/jakarta-messaging-tck-3.1.0.zip.
We have also moved the same to https://download.eclipse.org/ee4j/jakartaee-tck/jakartaee10/promoted/eftl/jakarta-messaging-tck-3.1.0.zip which will not be updated until requested.

Can you please use the TCK from either of these URLs for the CCR.

[pzygielo]

We have also moved the same to https://download.eclipse.org/ee4j/jakartaee-tck/jakartaee10/promoted/eftl/jakarta-messaging-tck-3.1.0.zip which will not be updated until requested.

Thank you.

Can you please use the TCK from either of these URLs for the CCR.

Done.

I asked in jakartaee/messaging#321 (comment) to update that issue with new values.

Link to promoted TCK could be updated here as well.

[jeanouii]

@pzygielo @alwin-joseph How are we looking?
Have you been able to address all feedback?
What's remaining?
We'll need to open the ballot vote quite quickly now to make sure we cross the finish line on time.

Do you need help on something?

[pzygielo]

@jeanouii - I'm not aware of any other pending task to be done in OpenMQ for that to proceed.
It's up to Messaging to update this PR and CCR, and we're good to go I guess.

[OndroMih]

I've updated this PR and the CCR PR to link to the promoted Messaging TCK.

[jeanouii]

Small fixes please and thank you

[jeanouii]

It's now all good.
I'll put it up for vote. Thanks

[jeanouii]

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 emo@eclipse-foundation.org. 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: Finalize the Jakarta Messaging 3.1 Release messaging#323