|
|
| Line 1: |
Line 1: |
| − | # Scan and make the following changes in javadocs and all text files such as (README.md, NOTICE.md, CONTRIBUTION.md, etc) in a repository
| + | Moved [https://wiki.eclipse.org/How_to_Prepare_API_Projects_for_the_Jakarta_EE_8_Release here]. |
| − | ## Update project name as it listed on Eclipse project page (ex. [https://projects.eclipse.org/projects/ee4j.jsonb Jakarta JSON Binding])
| + | |
| − | ## Update acronyms, use new acronyms, approved by a spec committee (see guideline [https://jakarta.ee/legal/acronym_guidelines/ here]).
| + | |
| − | ## Update references to other specifications with their new names
| + | |
| − | ## Leave existing "@since XYZ 1.x" uses alone. These refer to the old JCP version. Future additions should use the Jakarta project name.
| + | |
| − | ## Remove references to JCP process or replace them with references to JESP.
| + | |
| − | ##* Example: [https://jcp.org/en/jsr/detail?id=367 JSR-367] -> [https://projects.eclipse.org/projects/ee4j.jsonb Jakarta JSON Binding]
| + | |
| − | # Generate the "boilerplate" specification document, using the instructions and recommendations provided in the [https://docs.google.com/document/d/1EGSnr8mmNKIp3eb7odz6jpOoc3qwTISO3uzFMuvf5wc/edit Steering Committee guidance] (The document is still under Steering Committee review, but projects are free to take the recommended actions immediately).
| + | |
| − | #* Use the same spec version number as the previously released spec
| + | |
| − | # Make a staging release of API JAR from the revised source code.
| + | |
| − | #* Source code should use the new specification names and follow the acronym guidelines, and should remove any JSR references.
| + | |
| − | #* Javadocs should include the [https://raw.githubusercontent.com/eclipse-ee4j/jakartaee-api/master/licenses/EFSL.html Eclipse Foundation Specification License].
| + | |
| − | #* Version in pom.xml should be increased by 0.0.1 comparing to the previously released API artifact
| + | |
| − | #* Existing "@version ..." JavaDoc tags should be updated to match, or removed.
| + | |
| − | #* GAVs should remain as used in the Glassfish 5.1 release. They should not be updated for changes in the project names. That will be addressed post Jakarta EE 8.
| + | |
| − | #* Dependencies should be using the GAVs that use the jakarta.* groupId.
| + | |
| − | # Generate Stand-alone TCK test results. Use version staged on the previous step. There are some ways how to do it. Teams are free to choose any of them:
| + | |
| − | ## Create custom TCK test job
| + | |
| − | ##* Guidance is [https://www.eclipse.org/lists/ee4j-pmc/msg01985.html here].
| + | |
| − | ##* Save the test results when all tests succeed.
| + | |
| − | ## Manually run TCK by whatever means the project has used in the past. Save results when all tests succeed.
| + | |
| − | # When tests are passed submit for ballot by creating a PR against the [https://github.com/jakartaee/specifications Jakarta Spec Committee Spec Repo]
| + | |
| − | #* The project team creates [https://help.github.com/en/articles/about-pull-requests#draft-pull-requests two draft PRs] against the Jakarta EE Specification Committee specifications repository.
| + | |
| − | ## The first PR provides everything requested in the PR template except the javadoc contents.
| + | |
| − | ## The second PR would include the javadoc contents.
| + | |
| − | ##* These PRs are intended to provide the items that are required to validate the release, and provide the jakarta.ee website content for the specification. The repo has a PR template that lists the expected content for the PR. It includes:
| + | |
| − | ##** A directory using the specification code as defined in [https://docs.google.com/spreadsheets/d/18SraPxRBCOyaS6w-UV6TR-UA1bWy1--sV0ky6msAjWY/edit?usp=sharing Projects, Specifications, and Documents], e.g., wombat
| + | |
| − | ##** A subdirectory major.minor corresponding to the version of the spec,( e.g., 1.6), that contains:
| + | |
| − | ##*** Specification Document from (2) above in both pdf and html formats, e.g., wombat_1.6.pdf and wombat_1.6.html
| + | |
| − | ##*** Summary results of TCK run showing at least one compatible implementation
| + | |
| − | ##*** Link to final TCK test bundle if the spec defines a TCK
| + | |
| − | ##**** Final version of standalone TCK bundles will be uploaded to Eclipse downloads
| + | |
| − | ##*** The URL of the OSSRH staging repository for the api, javadoc artifacts
| + | |
| − | ##*** An apidocs directory containing the final JavaDocs (from 3) in the second PR.
| + | |
| − | # Creates a release record as described in https://www.eclipse.org/projects/handbook/#pmi-commands-release
| + | |
| − | # Requests approval for the release from the PMC by sending an email to ee4j-pmc@eclipse.org referencing the release record.
| + | |
| − | # Deliver an IP Log to the IP Team for their review as described in https://www.eclipse.org/projects/handbook/#pmi-commands-iplog.
| + | |
| − | # Contact the EMO to initiate the release review by sending an email to emo@eclipse.org.
| + | |
| − | # When approved
| + | |
| − | #* Release staged artifacts to Maven Central
| + | |
| − | # If (5) is accomplished prior to Ballot submission deadline (currently July 19) and Eclipse has released specification text to your project -- please feel free to start to generate a more detailed Jakarta EE specification, from the contributed specification text.
| + | |
| − | | + | |
| − | [[Category:Jakarta_EE]]
| + | |
