[
https://issues.apache.org/jira/browse/BEAM-6445?focusedWorklogId=185899&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-185899
]
ASF GitHub Bot logged work on BEAM-6445:
----------------------------------------
Author: ASF GitHub Bot
Created on: 16/Jan/19 17:33
Start Date: 16/Jan/19 17:33
Worklog Time Spent: 10m
Work Description: rohdesamuel commented on pull request #7529:
[BEAM-6445]: Release Guide changes for release process improvement
URL: https://github.com/apache/beam/pull/7529#discussion_r248380200
##########
File path: website/src/contribute/release-guide.md
##########
@@ -428,20 +419,59 @@ Javadoc to the Javadoc for other modules that Beam
depends on.
the version number has changed, download a new version of the corresponding
`<module>-docs/package-list` file.
+### Triage release-blocking issues in JIRA
+
+There could be outstanding release-blocking issues, which should be triaged
before proceeding to build a release candidate. We track them by assigning a
specific `Fix version` field even before the issue resolved.
+
+The list of release-blocking issues is available at the [version status
page](https://issues.apache.org/jira/browse/BEAM/?selectedTab=com.atlassian.jira.jira-projects-plugin:versions-panel).
Triage each unresolved issue with one of the following resolutions:
+
+For all JIRA issues:
+
+* If the issue has been resolved and JIRA was not updated, resolve it
accordingly.
+
+For all `Test` JIRA issues:
+
+* If the issue is a known continuously failing test, it is not acceptable to
defer this until the next release. Please work with the Beam community to
resolve the issue.
+* If the issue is a known flaky test, make an attempt to fix the issue.
However, if the issue may take too long to fix (to the discretion of the
release manager):
+ * Perform or delegate manual testing of flaky issue to ensure no release
blocking issues.
+ * Update the `Fix Version` field to the version of the next release. Please
consider discussing this with stakeholders and the dev@ mailing list, as
appropriate.
+
+For all other JIRA issues:
+
+* If the issue has not been resolved and it is acceptable to defer this until
the next release, update the `Fix Version` field to the new version you just
created. Please consider discussing this with stakeholders and the dev@ mailing
list, as appropriate.
+* If the issue has not been resolved and it is not acceptable to release until
it is fixed, the release cannot proceed. Instead, work with the Beam community
to resolve the issue.
+
+If there is a bug found in the RC creation process/tools, those issues should
be considered high priority and fixed in 7 days.
+
+### Review Release Notes in JIRA
+
+JIRA automatically generates Release Notes based on the `Fix Version` field
applied to issues. Release Notes are intended for Beam users (not Beam
committers/contributors). You should ensure that Release Notes are informative
and useful.
+
+Open the release notes from the [version status
page](https://issues.apache.org/jira/browse/BEAM/?selectedTab=com.atlassian.jira.jira-projects-plugin:versions-panel)
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.
### Checklist to proceed to the next step
1. Release Manager’s GPG key is published to `dist.apache.org`
-2. Release Manager’s GPG key is configured in `git` configuration
-3. Release Manager has `org.apache.beam` listed under `Staging Profiles` in
Nexus
-4. Release Manager’s Nexus User Token is configured in `settings.xml`
-5. JIRA release item for the subsequent release has been created
-6. There are no release blocking JIRA issues
-7. Release Notes in JIRA have been audited and adjusted
-8. Combined javadoc has the appropriate contents.
-9. Release branch has been created
-10. Originating branch has the version information updated to the new version
-11. Nightly snapshot is in progress (do revisit it continually)
+1. Release Manager’s GPG key is configured in `git` configuration
Review comment:
Gotcha, reverted back to explicit numbering
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
Issue Time Tracking
-------------------
Worklog Id: (was: 185899)
Time Spent: 1h 20m (was: 1h 10m)
> Improve Release Process
> -----------------------
>
> Key: BEAM-6445
> URL: https://issues.apache.org/jira/browse/BEAM-6445
> Project: Beam
> Issue Type: Improvement
> Components: project-management
> Reporter: Sam Rohde
> Assignee: Sam Rohde
> Priority: Major
> Time Spent: 1h 20m
> Remaining Estimate: 0h
>
> This JIRA tracks the improvement of the Beam release process as [discussed in
> the dev
> list|https://lists.apache.org/thread.html/d52ffbfca21eee953a230100520bd56d947a359c0029d5c291b736a7@%3Cdev.beam.apache.org%3E].
> In summary, this change will hopefully increase the greenness of the build
> by: increasing coverage, adding pre and post commits to release validation,
> and adding a regular cadence to look at flaky and backlogged tests.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
