Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dependency Injection 2.0 final PR #221

Merged
merged 6 commits into from Aug 28, 2020
Merged

Dependency Injection 2.0 final PR #221

merged 6 commits into from Aug 28, 2020

Conversation

starksm64
Copy link
Contributor

@starksm64 starksm64 commented Jul 7, 2020

Signed-off-by: Scott M Stark starksm64@gmail.com

Specification PR template

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

Include the following in PR#1:

Signed-off-by: Scott M Stark <starksm64@gmail.com>
@starksm64 starksm64 added draft Work in Progress wave:1 Used for release tracking purposes labels Jul 7, 2020
@netlify
Copy link

netlify bot commented Jul 7, 2020

Deploy preview for jakartaee-specifications ready!

Built with commit 66bb9f7

https://deploy-preview-221--jakartaee-specifications.netlify.app

Signed-off-by: Scott M Stark <starksm64@gmail.com>
@kwsutter kwsutter added this to the Jakarta EE 9 milestone Jul 8, 2020
@kwsutter kwsutter requested a review from edbratt July 14, 2020 22:32
Copy link
Contributor

@edbratt edbratt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please be sure to file a compatibility certification request issue in https://github.com/eclipse-ee4j/injection-api/issues and include a link in this discussion (check-box 8). [edit: or injection-spec/issues]
Current Spec. document status in the API repository still states "DRAFT" status. Don't forget to update the formal repository with these changes too.
For the spec document, just an opinion: I would have preferred to see text referring the reader to the JavaDocs for details since there is no detailed description in the specification document, other than the scope statement.
The Readme.md in the TCK refers readers to the injection-tck/issues issue-tracker. I thought the guidance was to ask users to file issues with the api project. Please double check and change if necessary.

@edbratt
Copy link
Contributor

edbratt commented Jul 18, 2020

I believe this check-list is complete. Thank you!

Spec Review Checklist

  1. Spec PR
  1. _index.md
  1. 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)
  1. 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
  1. Spec HTML
  • Same as PDF
  1. TCK zip file
  • README file (optional for this release)
  • EFTL license file, preferably named LICENSE.md
  • User's Guide (or equivalent documentation) - Readme.md
  • How to test the Compatible Implementation(s) listed in _index.md above with the TCK (may be in UG)
  1. TCK User's Guide (or equivalent documentation)
  • Software requirements listed
  • Installation and configuration described
  • How to run tests
  • Where to file challenges - Please see review comments
  1. Compatibility certification request
  • Request follows template
  • SHA-256 fingerprint matches staged TCK zip file
  • Request issue has certification label.
  1. TCK results summary (Please re-host the included TCK-summary.md page with the implementation (Weld)). Please include data found here: https://github.com/jakartaee/specification-committee/blob/master/compatibility-certification-request.md
  • 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
  1. Update Jakarta EE API jar (Please provide reference this has been completed)
  • 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. (jakartaee-api #70)

@Emily-Jiang
Copy link
Contributor

I am wondering whether we need to require the TCK result zip to be updated somewhere as the PR lists Scott's personal mac.

@kwsutter kwsutter requested a review from m0mus July 20, 2020 00:46
title: "Jakarta Dependency Injection 2.0 (milestone)"
date: 2020-05-18
title: "Jakarta Dependency Injection 2.0"
date: 2020-06-7
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should it be 2020-06-07?

title: "Jakarta Dependency Injection 2.0 (milestone)"
date: 2020-05-18
title: "Jakarta Dependency Injection 2.0"
date: 2020-06-7
summary: "Release for Jakarta EE 9"
---

Jakarta Dependency Injection specifies a means for obtaining objects in such a way as to maximize reusability, testability and maintainability compared to traditional approaches such as constructors, factories, and service locators (e.g., JNDI).

* [Jakarta Dependency Injection 2.0 Release Record]()
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Release record is missing. It should be https://projects.eclipse.org/projects/ee4j.cdi/releases/2.0

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@starksm64, Not sure why this item was resolved... Since DI is provided as part of the CDI project, then you should reference the CDI Release Record. As it stands today, the rendering of the _index.md file looks like the Release Record is missing (which it is). The easiest fix would be to just reference the CDI release record -- although there is no mention of the DI release in that release record. An easy edit can correct that though. Thanks.

* [Jakarta Dependency Injection 2.0 Javadoc](./apidocs)
* [Jakarta Dependency Injection 2.0 TCK](https://download.eclipse.org/ee4j/cdi/jakarta.inject-tck-2.0.0.RC4-bin.tar.gz) ([sig](https://download.eclipse.org/ee4j/cdi/jakarta.inject-tck-2.0.0.RC4-bin.tar.gz.asc),[sha](),[pub]())
* [Jakarta Dependency Injection 2.0 TCK](https://download.eclipse.org/ee4j/cdi/inject/2.0/jakarta.inject-tck-2.0.0-bin.tar.gz) ([sig](https://download.eclipse.org/ee4j/cdi/inject/2.0/jakarta.inject-tck-2.0.0-bin.tar.gz.asc),[sha](),[pub]())
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sha and pub links are missing.

@edbratt
Copy link
Contributor

edbratt commented Jul 20, 2020

Please update the details of the Release Record to indicate both CDI and DI are being released. If you'd prefer, you may generate multiple release records, one for CDI and DI. Update the release dates as well.
In the description, please include

a concise description that tells me the key features of the release. In the case of a specification project, the key features are the names and version number of the specifications included in the release.

Signed-off-by: Scott M Stark <starksm64@gmail.com>
Copy link
Contributor

@edbratt edbratt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for completing all items!

@edbratt
Copy link
Contributor

edbratt commented Aug 3, 2020

Rats. I just looked at the preview and it doesn't list the final TCK location.
The TCK summary and CCR uses:
https://download.eclipse.org/ee4j/cdi/inject/2.0/jakarta.inject-tck-2.0.1-bin.zip
The final TCK download link will be:
https://download.eclipse.org/jakartaee/dependency-injection/2.0/jakarta.inject-tck-2.0.1-bin.zip
The SHA-256 is listed as 7853d02d372838f8300f5a18cfcc23011c9eb9016cf3980bba9442e4b1f8bfc6
Lastly, we need the public key.

Signed-off-by: Scott M Stark <starksm64@gmail.com>
@starksm64
Copy link
Contributor Author

Done

@edbratt edbratt added complete All specification tasks for release are complete and removed draft Work in Progress labels Aug 4, 2020
@edbratt
Copy link
Contributor

edbratt commented Aug 4, 2020

LGTM! Thank you so much Scott! I've marked it complete. @kwsutter please review/update as needed.

Copy link
Contributor

@kwsutter kwsutter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two minor items need to be resolved and then we should be ready for ballot. Thanks, @starksm64!

dependency-injection/2.0/_index.md Outdated Show resolved Hide resolved
title: "Jakarta Dependency Injection 2.0 (milestone)"
date: 2020-05-18
title: "Jakarta Dependency Injection 2.0"
date: 2020-06-7
summary: "Release for Jakarta EE 9"
---

Jakarta Dependency Injection specifies a means for obtaining objects in such a way as to maximize reusability, testability and maintainability compared to traditional approaches such as constructors, factories, and service locators (e.g., JNDI).

* [Jakarta Dependency Injection 2.0 Release Record]()
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@starksm64, Not sure why this item was resolved... Since DI is provided as part of the CDI project, then you should reference the CDI Release Record. As it stands today, the rendering of the _index.md file looks like the Release Record is missing (which it is). The easiest fix would be to just reference the CDI release record -- although there is no mention of the DI release in that release record. An easy edit can correct that though. Thanks.

Signed-off-by: Scott M Stark <starksm64@gmail.com>
@kwsutter kwsutter self-requested a review August 5, 2020 15:26
Copy link
Contributor

@kwsutter kwsutter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thanks, @starksm64!

@kwsutter kwsutter added the final Ready for Vote label Aug 5, 2020
@dblevins dblevins added the ballot Delivered to the Specification Committee for ballot label Aug 5, 2020
@dblevins
Copy link
Contributor

dblevins commented Aug 5, 2020

Approved for Ballot. @edbratt will send out the vote when the instructions are found

Signed-off-by: Scott M Stark <starksm64@gmail.com>
@kwsutter kwsutter removed the complete All specification tasks for release are complete label Aug 6, 2020
@kwsutter
Copy link
Contributor

kwsutter commented Aug 6, 2020

Just removing the complete label since that's inconsistent with our defined use of labels for the review process. We should use the final label to indicate it's past draft and ready for ballot.

@dblevins dblevins changed the title Prepare dependency-injection final PR Dependency Injection 2.0 final PR Aug 19, 2020
Copy link
Contributor

@jeanouii jeanouii left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See comment bellow

* [Jakarta EE Platform 9 Release Plan](https://eclipse-ee4j.github.io/jakartaee-platform/jakartaee9/JakartaEE9ReleasePlan)
* [Jakarta Dependency Injection 2.0 Specification Document](./injection-spec-2.0-draft.pdf) (PDF)
* [Jakarta Dependency Injection 2.0 Specification Document](./injection-spec-2.0-draft.html) (HTML)
* [Jakarta Dependency Injection 2.0 Specification Document](jakarta-injection-spec-2.0.pdf) (PDF)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As per the template, if directory is wombat, then spec file name should also have wombat

Based on that, I would expect the file name to be jakarta-injection-spec-2.0.pdf (same for html).
Or then use inject only for consistency with TCK filename, and Maven coordinates.

What do you think?

@edbratt edbratt added the approved The ballot was approved by the Specification Committee label Aug 28, 2020
@edbratt
Copy link
Contributor

edbratt commented Aug 28, 2020

The specification ballot has concluded and this specification has been approved. Please update the ballot tally in _index.md prior to merging:

Representative Representative for: Vote
Kenji Kazumura Fujitsu 1
Dan Bandera, Kevin Sutter IBM 1
Ed Bratt, Dmitry Kornilov Oracle 1
Andrew Pielage, Matt Gill Payara 1
Scott Stark, Mark Little Red Hat 1
David Blevins, Jean-Louis Monteiro, Cesar Hernandez Tomitribe 1
Ivar Grimstad EE4J PMC 1
Marcelo Ancelmo, Martijn Verburg Participant Members 1
Werner Keil Committer Members 1
Scott (Congquan) Wang Enterprise Members 1
  Total 10

Well Done and my thanks to you and your team!

@edbratt
Copy link
Contributor

edbratt commented Aug 28, 2020

  • The specification committee mentor adds this final checklist to the main PR.
  • The specification committee member 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
  • The specification committee mentor merges the specification (and apidocs) PRs, ensuring the "date:" field in the _index.md file has an appropriate value to allow publishing.
  • The specification committee mentor 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 api staging release promotes the specification api jars to maven central. An example release job script can be found here https://wiki.eclipse.org/MavenReleaseScript.
  • The specification committee mentor 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.
  • The compatible implementation project/vendor MUST 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 appropriate for the branch management for the project.
    (Actions taken in Updated ballot results and confirmed TCK download specifics #262)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved The ballot was approved by the Specification Committee ballot Delivered to the Specification Committee for ballot final Ready for Vote wave:1 Used for release tracking purposes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants