[jira] [Commented] (FLINK-31151) Review Release Notes in JIRA

["Qingsheng Ren (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/FLINK-31151?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17703903#comment-17703903 ] 

Qingsheng Ren commented on FLINK-31151:
---------------------------------------

* Followed the guide to create [this page|https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12315522&version=12351585] on JIRA web UI, which collects all issues with fix version = 1.17.0 so some CI instabilities were included.
 * Used {{curl}} to export all issues with non-empty {{release note}} field. Adjusted the format and opened [this PR|https://github.com/apache/flink/pull/22146] to add release note in doc

> Review Release Notes in JIRA
> ----------------------------
>
>                 Key: FLINK-31151
>                 URL: https://issues.apache.org/jira/browse/FLINK-31151
>             Project: Flink
>          Issue Type: Sub-task
>            Reporter: Matthias Pohl
>            Priority: Major
>
> JIRA automatically generates Release Notes based on the {{Fix Version}} field applied to issues. Release Notes are intended for Flink users (not Flink committers/contributors). You should ensure that Release Notes are informative and useful.
> Open the release notes from the version status page by choosing the release underway and clicking Release Notes.
> You should verify that the issues listed automatically by JIRA are appropriate to appear in the Release Notes. Specifically, issues should:
>  * Be appropriately classified as {{{}Bug{}}}, {{{}New Feature{}}}, {{{}Improvement{}}}, etc.
>  * Represent noteworthy user-facing changes, such as new functionality, backward-incompatible API changes, or performance improvements.
>  * Have occurred since the previous release; an issue that was introduced and fixed between releases should not appear in the Release Notes.
>  * Have an issue title that makes sense when read on its own.
> Adjust any of the above properties to the improve clarity and presentation of the Release Notes.
> Ensure that the JIRA release notes are also included in the release notes of the documentation (see section "Review and update documentation").
> h4. Content of Release Notes field from JIRA tickets 
> To get the list of "release notes" field from JIRA, you can ran the following script using JIRA REST API (notes the maxResults limits the number of entries):
> {code:bash}
> curl -s https://issues.apache.org/jira//rest/api/2/search?maxResults=200&jql=project%20%3D%20FLINK%20AND%20%22Release%20Note%22%20is%20not%20EMPTY%20and%20fixVersion%20%3D%20${RELEASE_VERSION} | jq '.issues[]|.key,.fields.summary,.fields.customfield_12310192' | paste - - -
> {code}
> {{jq}}  is present in most Linux distributions and on MacOS can be installed via brew.
>  
> ----
> h3. Expectations
>  * Release Notes in JIRA have been audited and adjusted



--
This message was sent by Atlassian Jira
(v8.20.10#820010)