...
- Update
CHANGES.txt
to include the release version and date (useUnreleased
for the date if it is unknown) and remove Trunk add a new section,Master (unreleased changes)
. Commit these changes to trunk.
No Format svngit commit -mam "Preparing for release X.Y.Z"
Create a release branch for the release series:
No Format svngit copy https://svn.apache.org/repos/asf/avro/trunk \ https://svn.apache.org/repos/asf/avro/branches/checkout -b branch-X.Y
- Update
CHANGES.txt
remove theMaster (unreleased changes)
section because it isn't used in the release branch. Commit the update to the release branch.
No Format git commit -mam "BranchingPreparing for release X.Y releases.Z"
Return to the master branch.
UpdateNo Format git checkout master
CHANGES.txt
to add back inTrunk (unreleased changes)
.- Update the default version in in
share/VERSION.txt
on on trunk to X.(Y+1).0-SNAPSHOT. Be sure not to leave a trailing newline. Update the version in the Maven POM files to match with
No Format mvn versions:set -DnewVersion=X.(Y+1).0-SNAPSHOT -DgenerateBackupPoms=false
Commit these changes to trunkthe branch.
No Format svngit commit -mam "Preparing for X.(Y+1).0 development"
Push the master and branch changes:
No Format git push apache master git push apache branch-X.Y
Updating Release Branch
These operations take place in the release branch.
Check out the branch with:
No Format svngit co https://svn.apache.org/repos/asf/avro/branches/checkout branch-X.Y
- Update
CHANGES.txt
to include the release version and date (this change must be committed to trunk and any intermediate branches between trunk and the branch being released). - Update the version number in
share/VERSION.txt
to be ''avro-X.Y.Z-SNAPSHOT''. Be sure not to leave a trailing newline. Update the version in the Maven POM files to match with
No Format mvn versions:set -DnewVersion=X.Y.Z-SNAPSHOT -DgenerateBackupPoms=false
Commit these changes.
No Format svngit commit -mam "Preparing for release X.Y.Z"
- Add the fix version X.Y.Z to the Avro JIRA
If not already done, merge cherry-pick desired patches from trunk into the branch and commit these changes. You can find the revision numbers using
svn log CHANGES.txt
in the branch and in trunk.No Format cdgit checkout branch-X.Y svngit merge -rR1:R2 ../trunk . svn commit -m "Merge -r R1:R2 from trunk to X.Y branch. Fixes: AVRO-A, AVRO-B." cherry-pick <commit>
- For each patch merged, change the fix version for the JIRA issue to be X.Y.Z
- Go through CHANGES.txt, JIRA, and svn log to be sure that the issues included in the branch match in each location, then update the date in CHANGES.txt to be today.
- Update the version number in
share/VERSION.txt
to be ''X.Y.Z''. Be sure not to leave a trailing newline. Update the version in the Maven POM files to match with
No Format mvn versions:set -DnewVersion=X.Y.Z -DgenerateBackupPoms=false
Update the version number in
lang/c/version.sh
(the variableslibavro_micro_version
,libavro_interface_age
andlibavro_binary_age
) according to the libtool versioning rules as described in that file. Note the libtool version number is completely unrelated to the Avro release version number.Commit these changes.
No Format svngit commit -mam "Preparing to build X.Y.Z"
Tag the release candidate (R is the release candidate number):
No Format svngit copy https://svn.apache.org/repos/asf/avro/branches/branch-X.Y \ https://svn.apache.org/repos/asf/avro/tags/tag -s release-X.Y.Z-rcR -m "Avro X.Y.Z- rcR release."
Push the release tag and branch changes:
No Format git push apache release-X.Y.Z-rcR git push apache branch-X.Y
Building
Unless you have set up the required dependencies to build Avro for all languages, the following should be run inside a Docker container (see BUILD.txt for instructions).
...
Tag the release:
No Format svngit move https://svn.apache.org/repos/asf/avro/tags/checkout release-X.Y.Z-rcR \ https://svn.apache.org/repos/asf/avro/tags/ git tag -s release-X.Y.Z -m "Avro X.Y.Z release."
Copy release files to the release repository.
No Format svn copy https://dist.apache.org/repos/dist/dev/avro/avro-X.Y.Z-rcR \ https://dist.apache.org/repos/dist/release/avro/avro-X.Y.Z -m "Avro X.Y.Z release."
The release directory usually contains just two releases, the most recent from two branches, with a link named 'stable' to the most recent recommended version.
No Format svn co https://dist.apache.org/repos/dist/release/avro/ avro-release-dist cd avro-release-dist svn rm avro-A.B.C; rm stable ln -s avro-X.Y.Z stable svn commit -m "Avro X.Y.Z release."
- Publish Java artifacts to the Maven repository:
Find the Staging Repository and release it. Publish Python artifacts to PyPI. To do this you'll need an account on PyPi, and write access to the Avro package - ask the existing owners for permission if you don't have it.
No Format mkdir -p tmp/py cd tmp/py tar xzf ../../dist/py/avro-X.Y.X.tar.gz cd avro-X.Y.Z python setup.py sdist upload
Publish Python3 artifacts to PyPI.
No Format mkdir -p tmp/py3 cd tmp/py3 tar xvf ../../dist/py3/avro-python3-X.Y.Z.tar.gz cd avro-python3-X-Y-Z python3 ./setup.py sdist upload
Publish Ruby artifacts to RubyGems. Again, you'll need an account and you need to be an owner.
No Format gem push dist/ruby/avro-X.Y.Z.gem
Publish JavaScript artifacts to NPM. Again, you'll need an account and you need to be an owner.
No Format npm publish dist/js/avro-js-X.Y.Z.tgz
- Wait 24 hours for release to propagate to mirrors.
Prepare to edit the website.
No Format svn co https://svn.apache.org/repos/asf/avro/site
- Update the documentation links in
author/content/xdocs/site.xml
. - Update the release news in
author/content/xdocs/releases.xml
. Regenerate the site, review it, then commit it. Note that Forrest 0.9 is easiest (not currently in the Docker image), since it doesn't require Java 5.
No Format cd site ant firefox publish/index.html svn commit -m "Updated site for release X.Y.Z."
Copy the new release docs to website and update the
docs/current
link:No Format tar xzf dist/avro-doc-X.Y.Z.tar.gz mv avro-doc-X.Y.Z ../site/publish/docs/X.Y.Z cd ../site/publish svn add X.Y.Z rm current ln -s X.Y.Z current svn commit -m "Adding documentation for release X.Y.Z."
- Send announcements to the user and developer lists once the site changes are visible.
- Update the version number in
share/VERSION.txt
to be ''avro-X.Y.N-SNAPSHOT'', where ''N'' is one greater than the release just made. Update the version in the Maven POM files to match with
No Format mvn versions:set -DnewVersion=X.Y.N-SNAPSHOT -DgenerateBackupPoms=false
- In Jira, ensure that only issues in the "Fixed" state have a "Fix Version" set to release X.Y.Z.
- In Jira, "release" the version. Visit the "Administer Project" page, then the "Manage versions" page. You need to have the "Admin" role in Avro's Jira for this step and the next.
- In Jira, close issues resolved in the release. Disable mail notifications for this bulk change.
...