Skip to content

Commit

Permalink
Merge pull request #363 from KyleAure/release-process
Browse files Browse the repository at this point in the history
  • Loading branch information
KyleAure authored Nov 1, 2023
2 parents 79f18f3 + 5a5844f commit e07e920
Show file tree
Hide file tree
Showing 16 changed files with 493 additions and 286 deletions.
58 changes: 29 additions & 29 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,32 +3,32 @@ description: Jakarta Concurrency Bug Report
title: "[Bug]: "
labels: ["bug"] #Verified - label exists
body:
- type: markdown
attributes:
value: >
Report a mistake or inconsistency in the specification code, TCK tests, or documentation text.
If error is related to a TCK test after release, then use the TCK Challenge template instead.
- type: dropdown
id: version
validations:
required: true
attributes:
label: Specification Version
description: What version of the Concurrency Spec are you running using?
options: #TODO need to update this list per release
- 3.1.0-SNAPSHOT (Locally built)
- 3.0.2 (Generally available)
- 3.0.1 (Generally available)
- 3.0.0 (Generally available)
- type: textarea
validations:
required: true
attributes:
label: Bug report
value: |
> Description of the bug found.
- type: textarea
attributes:
label: Additional information
value: |
> Proposed solutions, code examples, ect.
- type: markdown
attributes:
value: |
> Report a mistake or inconsistency in the specification code, TCK tests, or documentation text.
> If error is related to a TCK test after release, then use the TCK Challenge template instead.
- type: dropdown
id: version
validations:
required: true
attributes:
label: Specification Version
description: What version of the Concurrency Spec are you running using?
options:
- 3.0.2
- 3.0.1
- 3.0.0
- SNAPSHOT (Locally built)
- type: textarea
validations:
required: true
attributes:
label: Bug report
placeholder: |
> Description of the bug found.
- type: textarea
attributes:
label: Additional information
placeholder: |
> Proposed solutions, code examples, ect.
178 changes: 88 additions & 90 deletions .github/ISSUE_TEMPLATE/certification.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,94 +3,92 @@ description: Jakarta Concurrency Platform Certification
title: "[Certification]: "
labels: ["certification"] #Verified - label exists
body:
- type: markdown
attributes:
value: >
Before submitting a Platform Certification to the Jakarta Concurrency community
please read and be familiar with the
[TCK Process document](https://jakarta.ee/committees/specification/tckprocess)
which may be updated occasionally.
- type: input
id: organization
validations:
required: true
attributes:
label: Organization
description: Organization name and URL (if applicable)
- type: input
id: implementation
validations:
required: true
attributes:
label: Implementation
description: Product name, version, and download URL (if applicable)
- type: input
id: specification
validations:
required: true
attributes:
label: Specification
description: Specification name, version, and download URL (if applicable)
- type: input
id: tck
validations:
required: true
attributes:
label: Technology Compatibility Kit (TCK)
description: TCK name, version, and download URL (if applicable)
- type: input
id: tckSHA
validations:
required: true
attributes:
label: Technology Compatibility Kit (TCK) Validation
description: TCK SHA-256 fingerprint
- type: textarea
id: tckResults
validations:
required: true
attributes:
label: Technology Compatibility Kit (TCK) Results
description: |
Public URL of TCK Results Summary
TIP: You can attach TCK Results to this issue by clicking this area to highlight it and then dragging files in.
- type: textarea
id: additionalRequirements
validations:
required: true
attributes:
label: Additional Specification Requirements
description: >
Specification projects may require additional items for a Certification Request
as defined in their corresponding TCK Documentation under the section labeled "Additional Certification Requirements".
- type: textarea
id: javaRuntime
validations:
required: true
attributes:
label: Java Runtime(s)
description: |
Java runtime(s) used to run the implementation.
Output from `java -version`
- type: textarea
id: environment
validations:
required: true
attributes:
label: Environments
description: Summary of the information for the certification environment, operating system, cloud, etc.
- type: checkboxes
id: ackEFTL
attributes:
label: Eclipse Foundation Technology Compatibility Kit License (EFTL)
description: Do you accept the terms of the (EFTL)?
options:
- label: By checking this box I acknowledge that the organization I represent accepts the terms of the [EFTL](https://www.eclipse.org/legal/tck.php)
- type: markdown
attributes:
value: |
> Before submitting a Platform Certification to the Jakarta Concurrency community please read and be familiar with the
> [TCK Process document](https://jakarta.ee/committees/specification/tckprocess) which may be updated occasionally.
- type: input
id: organization
validations:
required: true
- type: checkboxes
id: ackRules
attributes:
label: TCK Requirements and Compatibility
options:
- label: By checking this box I attest that all TCK requirements have been met, including any compatibility rules.
required: true
attributes:
label: Organization
description: Organization name and URL (if applicable)
- type: input
id: implementation
validations:
required: true
attributes:
label: Implementation
description: Product name, version, and download URL (if applicable)
- type: input
id: specification
validations:
required: true
attributes:
label: Specification
description: Specification name, version, and download URL (if applicable)
- type: input
id: tck
validations:
required: true
attributes:
label: Technology Compatibility Kit (TCK)
description: TCK name, version, and download URL (if applicable)
- type: input
id: tckSHA
validations:
required: true
attributes:
label: Technology Compatibility Kit (TCK) Validation
description: TCK SHA-256 fingerprint
- type: textarea
id: tckResults
validations:
required: true
attributes:
label: Technology Compatibility Kit (TCK) Results
description: |
Public URL of TCK Results Summary
TIP: You can attach TCK Results to this issue by clicking this area to highlight it and then dragging files in.
- type: textarea
id: additionalRequirements
validations:
required: true
attributes:
label: Additional Specification Requirements
description: |
Specification projects may require additional items for a Certification Request
as defined in their corresponding TCK Documentation under the section labeled "Additional Certification Requirements".
- type: textarea
id: javaRuntime
validations:
required: true
attributes:
label: Java Runtime(s)
description: |
Java runtime(s) used to run the implementation.
Output from `java -version`
- type: textarea
id: environment
validations:
required: true
attributes:
label: Environments
description: Summary of the information for the certification environment, operating system, cloud, etc.
- type: checkboxes
id: ackEFTL
attributes:
label: Eclipse Foundation Technology Compatibility Kit License (EFTL)
description: Do you accept the terms of the (EFTL)?
options:
- label: By checking this box I acknowledge that the organization I represent accepts the terms of the [EFTL](https://www.eclipse.org/legal/tck.php)
required: true
- type: checkboxes
id: ackRules
attributes:
label: TCK Requirements and Compatibility
options:
- label: By checking this box I attest that all TCK requirements have been met, including any compatibility rules.
required: true
50 changes: 25 additions & 25 deletions .github/ISSUE_TEMPLATE/clarification.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,28 @@ description: Jakarta Concurrency Clarification
title: "[clarification]: "
labels: ["question"] #Verified - label exists
body:
- type: markdown
attributes:
value: >
Request that some aspect of the specification be clarified.
- type: input
id: specification
validations:
required: true
attributes:
label: Specification
description: What specification is the clarification related to? Provide a link to the API class or SPEC document section.
placeholder: |
ex. [Aborted Exception](https://github.com/jakartaee/concurrency/blob/master/api/src/main/java/jakarta/enterprise/concurrent/AbortedException.java#L22)
- type: textarea
validations:
required: true
attributes:
label: I need clarification on ...
value: |
> Description of the clarification needed.
- type: textarea
attributes:
label: Additional information
value: |
> Proposed solutions, code examples, ect.
- type: markdown
attributes:
value: |
> Request that some aspect of the specification be clarified.
- type: input
id: specification
validations:
required: true
attributes:
label: Specification
description: What specification is the clarification related to? Provide a link to the API class or SPEC document section.
placeholder: |
ex. [Aborted Exception](https://github.com/jakartaee/concurrency/blob/master/api/src/main/java/jakarta/enterprise/concurrent/AbortedException.java#L22)
- type: textarea
validations:
required: true
attributes:
label: I need clarification on ...
placeholder: |
> Description of the clarification needed.
- type: textarea
attributes:
label: Additional information
placeholder: |
> Proposed solutions, code examples, ect.
58 changes: 58 additions & 0 deletions .github/ISSUE_TEMPLATE/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
name: Release
description: Propose a new minor/major release
title: "[Release]: "
labels: ["release"] #Verified - label exists
body:
- type: markdown
attributes:
value: |
This issue is to help the committers to the Jakarta Concurrency project to propose
and complete the release process.
- type: textarea
attributes:
label: Proposal
description: |
Why is a release needed?
validations:
required: true
- type: textarea
attributes:
label: Outstanding work
description: |
Issues / pulls to finish before this release can become generally available.
value: |
- [ ]
validations:
required: false
- type: textarea
attributes:
label: Check List
description: |
This is a checklist of what needs to be completed during the release process.
This checklist typically does not need to be edited prior to submitting this form.
value: |
#### Prepare
- [X] Open this issue.
- [ ] Complete outstanding work
#### Stage release
- [ ] [Build and stage artifacts to staging repository](https://ci.eclipse.org/cu/view/Release/job/concurrency_api_1-build-and-stage/)
- [ ] [Build and stage the TCK distribution artifact to download.eclipse.org](https://ci.eclipse.org/cu/view/Release/job/concurrency_tck_1-build-and-stage/)
- [ ] Update this issue with a comment that links to the staged artifacts and the generated GitHub branch and tag
- [ ] [Create a `pre-release` on GitHub](https://github.com/jakartaee/concurrency/releases/new)
#### Verify and modify
- [ ] Ask for feedback from the community to verify the staged artifact has all the expected changes.
- [ ] If anything needs to be added before publishing do that now and repeat the `Stage Release` section
#### Publish release
- [ ] [Publish staged artifacts to the public repository](https://ci.eclipse.org/cu/view/Release/job/concurrency_api_3-staging-to-release/)
- [ ] [Publish staged TCK distribution artifact to download.eclipse.org](https://ci.eclipse.org/cu/view/Release/job/concurrency_tck_2-staging-to-promoted/)
- [ ] Update this issue with a comment that links to the published artifacts and the generated GitHub branch and tag
- [ ] [Modify the `pre-release` on GitHub to be `latest`](https://github.com/jakartaee/concurrency/releases)
#### Follow up
- [ ] [Email the Concurrency Mailing list to have a Jakarta Steering Committee member promote the TCK Distribution publically](https://accounts.eclipse.org/mailing-list/cu-dev)
- via [Jenkins build](https://ci.eclipse.org/jakartaee-spec-committee/job/promote-release/)
- [ ] Update versions in non-build files, such as:
Documentation:
- [tck/README.adoc](https://github.com/jakartaee/concurrency/tree/main/tck#getting-the-tck)
- [concurrency-tck-reference-guide.adoc](https://github.com/jakartaee/concurrency/blob/main/tck-dist/src/main/asciidoc/concurrency-tck-reference-guide.adoc)
validations:
required: true
Loading

0 comments on commit e07e920

Please sign in to comment.