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

Jakarta Security 4.0 #741

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Conversation

arjantijms
Copy link
Contributor

@arjantijms arjantijms commented May 9, 2024

Specification PR template

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

Include the following in the PR:

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

Signed-off-by: Arjan Tijms <arjan.tijms@omnifish.ee>
Copy link

netlify bot commented May 9, 2024

Deploy Preview for jakartaee-specifications ready!

Name Link
🔨 Latest commit a0c8e31
🔍 Latest deploy log https://app.netlify.com/sites/jakartaee-specifications/deploys/6658590e68cf450008b1feef
😎 Deploy Preview https://deploy-preview-741--jakartaee-specifications.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@ivargrimstad ivargrimstad added the release review Use this label on PRs that are filed for release review label May 12, 2024
@mtdelgadoa
Copy link

mtdelgadoa commented May 13, 2024

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

EDP Review status: EMO Completed - waiting on ballot results

EMO review checklist

PMI record: URL

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

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:

See examples for Security file and Code of Conduct.

Required elements:

  • ECA is referenced/described

Recommended elements:

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

@ivargrimstad
Copy link
Member

ivargrimstad commented May 26, 2024

Mentor 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)
  • 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
  1. Compatibility certification request
  • Request follows template
  • SHA-256 fingerprint matches staged TCK zip file
  • Request issue has certification label.
  1. 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
  1. 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.)

    • The specification project team requests approval by sending an email to the EMO (with cc to the PMC) that contains a link to this PR and a request to the PMC for approval.
  2. 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
Copy link
Contributor

jeanouii commented May 29, 2024

Left a small comment on the CSR for Soteria. Small detail.
The TCK ZIP content has a weird structure but not a blocker

image

there is also an old-tck/ directory in there. Not sure what it is about but it was also there before.

Finally, I don't see a link to the Maven entry for the API jar. It's usually under the TCK links.
For the rest, see the checklist.

security/4.0/_index.md Show resolved Hide resolved
security/4.0/_index.md Outdated Show resolved Hide resolved
@arjantijms
Copy link
Contributor Author

old-tck/ directory in there. Not sure what it is about but it was also there before.

That is an embedded version of the old tck (the javatest/ant based one). Because of a lack of resources we don't have time to convert it to the new style tests. A number of other TCKs does/did the same thing.

@arjantijms
Copy link
Contributor Author

@jeanouii is everything now correct?

@ivargrimstad
Copy link
Member

@jeanouii is everything now correct?

It looks good to me. Please go ahead @jeanouii and start the ballot.

@ivargrimstad ivargrimstad added ballot Delivered to the Specification Committee for ballot final Ready for Vote labels Jun 12, 2024
@ivargrimstad
Copy link
Member

I will start the ballot now

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ballot Delivered to the Specification Committee for ballot final Ready for Vote release review Use this label on PRs that are filed for release review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants