Release Process
Every PMC member should read the below docs at least once, several times, because eventually, after graduation, the NetBeans PMC members will be responsible to verify and ensure releases are done in compliance with these rules:
- See the generic Apache Release process – http://www.apache.org/dev/release-publishing.html.
- See the generic Apache Release FAQ – http://www.apache.org/legal/release-policy.html.
- See the ASF policy and documentation for releases: http://www.apache.org/dev/#releases.
- See the necessary steps and requirements for the release distribution -- http://www.apache.org/dev/release-distribution.html.
Specific Steps, Details, and Examples
See:
as a reference done for Apache NetBeans 10.0
After reading the above, some specific steps and details and examples below.
- PMC vote and tally.
- During incubation, IPMC vote, for example:
https://lists.apache.org/thread.html/ae06af5a10d99a14e35a0fee8a8e35e91505b85293549f8152a075d4@%3Cgeneral.incubator.apache.org%3E
Conclude and tally the vote on general@ by replying with a final [RESULT][VOTE] <subject>, which can be done after minimal 72h. Check the general@ list for examples on the format and content of such [RESULT][VOTE] emails, for example:
https://lists.apache.org/thread.html/30c40866c0ad97d747c270dc7b7ddc78f60157695763bf355e1697a4@%3Cgeneral.incubator.apache.org%3E - The source distribution at https://dist.apache.org/repos/dist/dev/incubator/netbeans/
needs to be moved (can use svn mv for that) to :
https://dist.apache.org/repos/dist/release/netbeans/netbeans/ - Also, the KEYS file needed to verify netbeans distributions needs to be uploaded in the root (netbeans) dist folder there as well:
http://www.apache.org/dev/release-distribution.html#sigs-and-sums - Finally, the NetBeans website (netbeans.apache.org) needs to provide a download link for the distribution, including (explicitly) links to:
http://www.apache.org/dev/release-distribution.html#download-links
i.e., update the website with the release info, as that is required to make it a proper and community-visible release.
Note: If the main site is not syncing go to selfserve.apache.org and click "synchronize git repositories".
Before you start
1. Make sure you have the Right Permissions
- You must be a PMC member / Committer in Apache NetBeans
- You must have connected your Apache ID to Apache NetBeans GitHub via GitBox: https://gitbox.apache.org
- You must be able to change the branch being used for Jenkins builds,
i.e., see - You shall have a PGP KEY
- You need to have sudo access to netbeans-vm.apache.org
Producing a Beta
1. Obtaining and Preparing the Beta files
- Determine the version of the release, e.g. 11.1-beta1, for the first beta. Later it's going to be referred as $VERSION
- Go to the netbeans-release job on Apache's Jenkins
- Build with Parameters, fill $VERSION into the VERSION input line and Build
- Wait for the job to be finished.
- Download and extract the build artifacts.
Check the SHA512 checksums:
find . -name '*.sha512' -exec sha512sum --check '{}' \;
2. Distributing Beta via mailing lists
- Beta releases should be distributed directly from the Jenkins build job - eg.
Producing a Release Candidate
1. Obtaining and Preparing the Release Candidate Files
- Determine the version of the release, e.g. 11.0-vc1, for voting candidate 1, later it's going to be referred as $VERSION
- Go to the netbeans-release job on Apache's Jenkins
- Build with Parameters, fill $VERSION into the VERSION input line and Build
- Wait for the job to be finished.
- Download and extract the build artifacts.
Check the SHA512 checksums:
find . -name '*.sha512' -exec sha512sum --check '{}' \;
NB. check (and create if necessary) .sha512 files for nbm/updates.xml and nbm/tasks.jar
Sign the Release Files
find . -name '*.zip' -exec gpg -u YOU@apache.org --armor --output {}.asc --detach-sign {} \; # Stop here if nbms are not going to be published find . -name '*.nbm' -exec gpg -u YOU@apache.org --armor --output {}.asc --detach-sign {} \; find . -name '*.gz' -exec gpg -u YOU@apache.org --armor --output {}.asc --detach-sign {} \; # nbm/updates.xml and nbm/tasks.jar added since NB 11.0 find . -name '*.jar' -exec gpg -u YOU@apache.org --armor --output {}.asc --detach-sign {} \; find . -name '*.xml' -exec gpg -u YOU@apache.org --armor --output {}.asc --detach-sign {} \;
Verify Signatures
find . -name '*.asc' -exec gpg --verify {} \;
2. Verifying the Release by Checklist
- Go through the Apache Incubator Release Checklist
(whether a project is in the Apache Incubator or not, these items need to be checked since they're important for all Apache releases) - Check the Product version:
Start Apache NetBeans and check the Title and the Help > About Dialog - Check that the splash screen has been updated.
- Check that the keyboard shortcut card has been updated.
- Check that the user directory matches the release number.
- Check GPL License is present and need to be accepted:
- Start NetBeans with an empty User directory
- Open a Java SE project: installing nb-javac shall present GPL
- Start NetBeans with an empty User directory
- Create a new PHP project: installing Graal JS shall present GPL
3. Publishing them in the staging area
Create an empty directory for the release then:
svn checkout --depth immediates https://dist.apache.org/repos/dist/ apache-dist cd apache-dist/dev && svn update --depth immediates netbeans cd netbeans && svn update --set-depth infinity
Publish to Staging Area
svn rm netbeans-platform/* netbeans/* mkdir netbeans-platform/$VERSION, netbeans/$VERSION # Copy the netbeans-platform and netbeans artifacts with checksums and signatures in place svn add netbeans-platform/* netbeans/* svn --username "<your-apache-username>" commit -m "Apache NetBeans $VERSION."
4. Creating tag for the Release:
Go to your local git repository clone. Collect the git commit hash from the release build job.
git fetch --all git tag -a $VERSION -m "Apache NetBeans $VERSION." $HASH git push origin $VERSION # or if you've disabled upstream push git push https://github.com/apache/netbeans.git $VERSION
5. Releasing a Release
While vote candidate $VERSION is something, like: 11.0-vc1, the actual $RELEASE_VERSION is: 11.0
# Go to the apache-dist directory which had been previously checked out in Step 4. cd release && svn update --depth immediates netbeans cd netbeans/netbeans && svn update --set-depth infinity # svn rm netbeans-platform/* netbeans/* # need to keep LTS and latest non-LTS ? # Use svn move or copy to copy the the artifact from the staging area svn mv ../../../dev/netbeans/netbeans-platform/$VERSION netbeans-platform/$RELEASE_VERSION svn mv ../../../dev/netbeans/netbeans/$VERSION netbeans/$RELEASE_VERSION
- Go to the release version directories and rename the release candidate artifacts to have the release version in their name.
- Adjust the name change in the checksum files (or recreate them)
- Doublecheck the checksums with: find . -name '*.sha512' -exec sha512sum -c {} \;
- Commit the changes from the apache-dist directory
6. Updating redirect for NetBeans Distribution Update Center
Once release is synchronized across all download mirrors it is necessary to update redirect for release modules to final location:
- Login to NetBeans virtual machine where redirect is configured: ssh <your_apache_id>@netbeans-vm.apache.org
Become root using e.g. OTP MD5 online encryption: sudo /bin/bash
sudo /bin/bash cd /var/www/html/uc/ mkdir 11.1 cd 11.1/ curl https://dist.apache.org/repos/dist/release/netbeans/netbeans/11.1/nbms/updates.xml.gz -o updates.xml.gz echo ' RedirectMatch ^/uc/11.1/(.*)(\?.*)?$ http://www.apache.org/dyn/closer.lua?action=download&filename=netbeans/netbeans/11.1/nbms/$1' > .htaccess # Update the previous version UC - need to keep LTS and non-LTS! cd ../10.0/ echo 'RedirectMatch ^/uc/10.0/(.*)(\?.*)?$ https://archive.apache.org/dist/incubator/netbeans/incubating-netbeans/incubating-10.0/nbms/$1' > .htaccess vim updates.xml.gz
Modify updates.xml.gz file of previous release to contain: (how to handle LTS vs non-LTS?)
<notification url="https://netbeans.apache.org/download/index.html">Apache NetBeans IDE 11.0 is available!</notification>
element in its <module_updates> root element.
NOTE: For accessing the NetBeans Virtual VM please see netbeans-vm.apache.org