Table of Contents | ||
---|---|---|
|
Overview
The release manager lead role in Apache MXNet means you are responsible for a few different things:
...
- You are a current project committer
- You’ve gained access to configure build jobs at builds.apache.org as a part of the jobsadmin group (ask a PMC mentor to add you)
1. Preparing the Release Candidate:
...
After every release, the community should decide on a list of features to deliver for the following release. When the clear target date for a release has been estimated, the release manager lead should inform the community of the release schedule. All features which the community wishes to include in the release should be merged and tested successfully before the date of the first release candidate. The first release candidate should be on a commit which passed builds from at least 3 days before cutting the release candidate. This will make the release managerlead's job easier. Below is a template for the information:
...
- Bump up the version number. An example can be followed here: https://github.com/apache/incubator-mxnet/pull/6462, update https://github.com/apache/incubator-mxnet/blob/master/setup-utils/install-mxnet-osx-python.sh#L36
More recent example - https://github.com/apache/incubator-mxnet/pull/8567
make sure no broken/non-existing links are added to the master branch. - Update NEWS and README. An example can be followed here: https://github.com/apache/incubator-mxnet/pull/6471
Create a RSA GPG key of length 4096, upload it to the public server, and add it to the KEYS file (do this process once for each release managerlead): https://github.com/apache/incubator-mxnet/blob/master/KEYS & https://dist.apache.org/repos/dist/dev/incubator/mxnet/KEYS See more detailed instructions on creating the key here: https://www.apache.org/dev/openpgp.html#generate-key
Code Block language bash title Adding Keys # checkout the apache mxnet repo svn co https://dist.apache.org/repos/dist/dev/incubator/mxnet apache-mxnet cd apache-mxnet # update the KEYS file ... # commit the update svn commit -m “update keys file for xxx ” --username your_username --password your_passwd
...
Should any vote fail to reach quorum or release manager lead determines that another RC needs to go out, the release manager lead should triage the issues, create GitHub issues, and move to fix the issues. Once fixed, make changes to NEWS & README.md in case it specifically lists the old RC# number. Start the process for another release candidate. In the new voting email, detail what has changed since the last release candidate. Repeat until the vote passes.
...
Task # | Task | Owner | Relative Date | Absolute Date |
PreReqs for Release Start: | PM | |||
1 | Finalize the Release Date | PM | T-15 | |
2 | High Level List of Features and artifact specs | PM | T-15 | |
3 | Prepare Release Notes - draft 1 | PM | T-15 | |
4 | Inform the community | Release CommitterReleaseLead | T-15 | |
5 | PR to update the Website into master/RB | WebsiteLead | T-14 | |
6 | PR to update the Docs into master/RB | DocsLead | T-14 | |
7 | PR to update the versions into master/RB | ReleaseLead | T-14 | |
8 | Validate Licenses (how? Apache RAT and?) | ReleaseLead | T-14 | |
9 | Validate/update submodules | ReleaseLead | T-14 | |
10 | Stabilize the code for CI to pass | ReleaseLead | T-14 | |
11 | Merge all necessary PRs into master | Community | T-13 | |
12 | Code Freeze and Release Start: Cut the Release BranchRelease | ManagerReleaseLead | T-10 | |
13 | Finalize the Release Notes based on PRs that got in - final draft | PM | T-10 | |
14 | PR to update the NEWS and README into the RB | ReleaseLead | T-9 | |
15 | validate the docs build locally (how?) | DocsLead | T-9 | |
16 | Test part 1: Run the unit Tests on the Release Branch | ReleaseLead | T-8 | |
17 | Test part 2: Run the Nightly Tests | ReleaseLead | T-8 | |
18 | Create the Github Tag for the rc0 | Release CommitterReleaseLead | T-7 | |
19 | Create the src tar and sign, Upload the src tar | Release CommitterReleaseLead | T-7 | |
20 | Validate the signatures | Release Lead | T-7 | |
21 | Clone svn repo and do a manual test | Release Lead | T-7 | |
Begin Apache Voting | Release CommitterReleaseLead | T-7 | ||
22 | Start the vote on devl@dev@ | ReleaseLead | ||
23 | Send out the results of the vote on dev@ | Release CommitterReleaseLead | T-4 | |
24 | Revote if necessary (Steps 15-22) | Release CommitterReleaseLead | Not Accounted For | |
25 | Start the vote on general@ | Release CommitterReleaseLead | T-4 | |
26 | Send out the results of the vote on general@ | Release CommitterReleaseLead | T-1 | |
End Apache Voting | ||||
27 | Create the final release tag on github | Release CommitterReleaseLead | T-1 | |
28 | Rename, resign and upload the src tar to final dir | Release CommitterReleaseLead | T-1 | |
29 | Update the website using tag | Website Lead | T-1 | |
30 | Release the official pip package | pip Lead | T-1 | |
31 | Release the official docker images | Docker Lead | T-1 | |
32 | After 24 hrs, validate the packages are uploaded | Release Lead | T | |
33 | Draft the offical announce email and review | Release CommitterLead | T-1 | |
34 | Send out the email on announce@ | Release CommitterLead | T | |
35 | Update the apache blog | Release CommitterLead | T | |
36 | update the aws blog | PM | T | |
37 | send internal announcement | PM | T | |
38 | Update the version on master | Release Lead | T+1 |
Notes for reference
*NOTES FROM DOCS FOR REFERENCE:* http://incubator.apache.org/guides/releasemanagement.html - 3 +1 votes from IPMC members (these are the votes that count but we should open up to the whole podling community) - For podlings, 2 additional constraints: - Release artifacts must include “incubating” in final file name (ex: apache-mxnet-src-0.10.1-incubating.tar.gz) - Release artifacts must include disclaimer in the release artifacts - The Incubator PMC expects the source releases to be staged on https://dist.apache.org/repos/dist/dev/incubator/podlingName so that they can easily be moved to the release location via svn mv ( http://www.apache.org/dist/incubator/) - After graduating, RC’s go into https://dist.apache.org/repos/dist/dev/ and official releases go into https://dist.apache.org/repos/dist/release/ http://incubator.apache.org/guides/branding.html#disclaimers - Apache Press Team [http://www.apache.org/press/index.html#whoweare] must review and coordinate releases for branding - On website and in release DISCLAIMER file: - Apache Podling-Name is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the name of Apache TLP sponsor. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF. - Website should include Apache Incubator logo: http://incubator.apache.org/guides/press-kit.html - Release should include: - DISCLAIMER - LICENSE - NOTICE - attribution notices http://www.apache.org/legal/release-policy.html - A release must contain source package which is cryptographically signed by Release Managerlead with detached signature. It must be tested prior to voting for release. - Release must only contain appropriately licensed code - Please ensure you wait >=24 hours after uploading a release before making announcements so mirrors catch up - Releases of more than 1GB of artifacts require a heads-up to Infrastructure in advance. - Which directory for what build? http://www.apache.org/legal/release-policy.html#build-directories http://www.apache.org/dev/release-distribution.html - Artifacts MUST be accompanied by: - apache-mxnet-src-0.10.1-incubating.asc - contains OpenPGP compatible ASCII armored detached signature - apache-mxnet-src-0.10.1-incubating.md5 - MD5 checksum - apache-mxnet-src-0.10.1-incubating.sha - SHA checksum (SHOULD) - Publish KEYS file in distribution directory root - Signing keys MUST be published in KEYS file, SHOULD be available in global public keyserver http://www.apache.org/dev/release-signing#keyserver, SHOULD be linked into web of trust - Keys MUST be RSA & 4096 bits http://www.apache.org/dev/release-publishing.html - Apache RAT can assist in checking license compliance http://creadur.apache.org/rat/ - Eventually we should set up a build system to sign our releases with cryptographic signatures. For now we’ll do it manually. http://www.apache.org/dev/release-signing.html - Create a signature and sign releases as mentioned above
...