Jakarta Annotations 1.3 spec

[m0mus]

Signed-off-by: Dmitry Kornilov dmitry.kornilov@oracle.com

• 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 wombat_x.y.pdf
• Specification HTML in the form of wombat_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.
• The URL of the OSSRH staging repository for the api, javadoc:
  https://oss.sonatype.org/content/repositories/staging/jakarta/annotation/jakarta.annotation-api/1.3.5/
• The URL of the staging directory on downloads.eclipse.org for the proposed EFTL TCK binary:
  http://download.eclipse.org/ee4j/jakartaee-tck/jakartaee8-eftl/promoted/eclipse-annotations-tck-1.3.0.zip
• The URL of the compatibility certification request issue:
  Compatibility certification request for Jakarta Annotations 1.3.5 common-annotations-api#59

[starksm64]

It looks like there are supurious files in here:

• annotations/1.3/license-efsl.adoc
• annotations/1.3/images/jakarta_ee_logo_schooner_color_stacked_default.png

[starksm64]

Are we strict about spec title including a version or not? These have "Jakarta Annotations 1.3" as the "Specification: " field value.

[starksm64]

For wave 1, this spec should be due by 8/7, so please review this ASAP. Note there is a good checklist for https://github.com/jakartaee/specification-committee/blob/master/spec_review_checklist.md

[m0mus]

It looks like there are supurious files in here:

* annotations/1.3/license-efsl.adoc

* annotations/1.3/images/jakarta_ee_logo_schooner_color_stacked_default.png

Fixed

[starksm64]

Spec Review Checklist

1. Spec PR

• PR uses template
• Directory of form {spec}/x.y
• PDF of form {spec}-spec-x.y.pdf ("-spec" preferred but not required)
• HTML of form {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://oss.sonatype.org/conte/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}
• Second PR for just apidocs

2. _index.md

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

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

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

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
  ada069841408ba88378bb1813977ccdef4eb85e02097ba36de44bbd39cbd7c6c
• 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

[starksm64]

Looks complete except for the "Draft..." in the summary of the 1.3/_index.md

[bshannon]

• On ballot completion

• The designated specification committee representative adds this final checklist to the main PR.
• The specification committee representative merges the specification PRs.
• The designated specification committee representative 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.
• The specification project member who created the staging release promotes the specification api jars to maven central.
• The EMO updates the specification page with the ballot results.
  This list goes on the committed spec index page.
• The specification project team should go through the merged spec website page to verify all the links are valid.
• The specification project team should approve the compatibility request and send an email to tck@eclipse.org for approval of the compatible implementation for trademark usage.
• The specification project team should merge any final release branch as approriate for the branch management for the project.

[dblevins]

@m0mus The staged API binaries will be expired and deleted automatically by Nexus OSSRH on Sunday, Sept 1 st. Can you publish this api jar to Maven Central at your earliest convenience?

[m0mus]

I don't see that it's published on the web site: https://jakarta.ee/specifications/

[m0mus]

@dblevins Yes, we will release it today.

[m0mus]

• The specification project member who created the staging release promotes the specification api jars to maven central.
• The specification project team should go through the merged spec website page to verify all the links are valid.
• The specification project team should approve the compatibility request and send an email to tck@eclipse.org for approval of the compatible implementation for trademark usage.
• The specification project team should merge any final release branch as approriate for the branch management for the project.

I checked the links on the staged web site here. Everything is fine except a link to TCK. The link looks correct. I guess that it doesn't work because TCK is not available there yet. Please confirm.

[starksm64]

I see the TCK under this directory:
https://download.eclipse.org/jakartaee/annotations/1.3/?d

[m0mus]

@starksm64 How I can change the link on the web site?

[edbratt]

Generate another PR to correct it.

…

On 9/5/2019 7:00 AM, Dmitry Kornilov wrote: @starksm64 <https://github.com/starksm64> How I can change the link on the web site? — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#69?email_source=notifications&email_token=AC5WM3QCJNI3DKNWN65NUVTQIEGIRA5CNFSM4IIPBM6KYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD57GXHY#issuecomment-528378783>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AC5WM3R2XPFTHWPCLUJ5WU3QIEGIRANCNFSM4IIPBM6A>.

[m0mus]

PR with TCK link fix submitted: #110

[bshannon]

Looks like this spec is done!