Wiki

Clone wiki

upcxx / internal / ReleaseProcedure

  1. Update UPCXX_VERSION and UPCXX_SPEC_VERSION definitions in src/upcxx.hpp
    1. should be of the form: YYYYMMPP
    2. Y and M represent numeric year and month of the release
    3. PP = patch number, starting at 0 for a "normal" (ie not hotfix) release
    4. PP should be zero for UPCXX_SPEC_VERSION
  2. Update version info in utils/upcxx-run:load_args()
  3. Update GASNet-EX spec version floor in src/backend/gasnet/runtime_internal.hpp and corresponding error message
  4. Update ChangeLog
  5. Update nobs default URL to point at EX release tarball. This should look like: https://gasnet.lbl.gov/EX/GASNet-YYYY.MM.PP.tar.gz
    Note the https and host
  6. Commit final guide PDF to docs/guide.pdf
    1. validate tech report number and version number on the cover and PDF metadata are correct
    2. upload to berkeleylab/upcxx downloads area with name like upcxx-guide-2017.9.0.pdf
    3. TAG the guide repo
  7. Commit final spec PDF to docs/spec.pdf
    1. validate tech report version number on the cover is correct
    2. validate UPCXX_SPEC_VERSION and the matching version on the cover and PDF metadata
    3. upload to berkeleylab/upcxx downloads area with name like upcxx-spec-2017.9.0.pdf
    4. TAG the spec repo
  8. Generate source release-candidate tarball (from git working dir)
    1. Run the follow command in the git working directory:
      env REPO=origin BRANCH=develop utils/release.sh
    2. Confirm the final output matches the expected version numbers.
    3. Upload this release candidate to a private download area (e.g. private fork with group access)
  9. Email local group to review the release-candidate
  10. Ask an ADMIN to grant you WRITE access to the 'master' branch
  11. Merge to master (updating version below)
    git remote update
    git checkout master
    git pull --ff-only
    git merge --no-ff -m 'Merge develop for 2017.9.0 release' origin/develop
    (push to a private fork on BitBucket or inspect locally with git log)
    git push origin master
  12. Ask an ADMIN to revoke WRITE access to the 'master' branch
  13. TAG master (updating version below)
    git tag -a -m 'UPC++ 2017.9.0 release' upcxx-2017.9.0 master
    git push origin upcxx-2017.9.0
  14. Generate final tarball - must come AFTER the previous step has pushed to remote
    1. Run the follow command in the git working directory
      env REPO=origin BRANCH=master utils/release.sh
      Confirm the final output matches the expected version numbers.
    2. Validate the git hash matches the tip of master holding the release tag.
    3. Collect the md5sum for the generated tarball (at end of the output).
    4. Upload the final tarball to (public) berkeleylab/upcxx downloads area.
  15. Download the tarball just uploaded into a different directory.
    1. Run md5sum on the download and verify it matches the checksum from the previous step.
    2. Extract the packaged git hash:
      gzip -cd upcxx-2017.9.0.tar.gz | git get-tar-commit-id
    3. Validate the git hash matches the tip of master holding the release tag.
    4. Unpack the tarball and inspect the contents of README.md and src/upcxx.hpp for correct versioning.
  16. Advance draft number and append ".dev" suffix on spec master branch in upcxx-spec.tex
  17. Advance patch number in upcxx-prog-guide/Makefile
  18. Advance patch version number on develop branch in src/upcxx.hpp
  19. Change nobs URL back to https://gasnet-bugs.lbl.gov/nightly/unlisted/GASNet-stable.tar.gz on develop
  20. Tag the develop branch to match the new content of src/upcxx.hpp
    git tag -a -m 'tagging YYYY.M.P for development' upcxx-YYYY.M.P develop
  21. Push the previous several steps (substituting the correct version).
    git push origin develop upcxx-YYYY.M.P
  22. Tag the upcxx-extras repo to record the release point: git tag -a -m 'tagging YYYY.M.P for development' upcxx-YYYY.M.P develop
    git push origin upcxx-YYYY.M.P
    1. Consider also merging upcxx-extras develop branch to master, and tagging as upcxx-extras-YYYY.MM.DD
  23. Review and revise the release announcement
  24. Navigate to the wiki and git clone it to your local system
  25. Add any new publications (eg updated spec or guide) to
    wiki/Publications.md
    wiki/pagoda.bib
    wiki/pubs/*.pdf
  26. Update the GASNet-EX version table in the wiki
  27. Update all 3 issue trackers: add this release to Versions, next one to Milestones and as default Milestone
  28. Update NEWS and Download sections of wiki/Home.md with info on the new release download including links, moving old links to a new line in the Previous Releases section
  29. Run the script wiki/internal/import-release.sh to import the documentation from the release, overwriting the corresponding files in the working copy. Be sure to audit the changes before committing to look for information loss.
  30. Push your wiki changes and audit everything on the live page, especially checking for broken links.
  31. Add md5sum of each download (code, guide, spec) to announcement
  32. Send the announcement to upcxx@googlegroups.com, upcxx-announce@lbl.gov
  33. Ask Dan or Paul to update the SourceForge download mirror
  34. Bug Paul to install on NERSC, Dirac, Kotten, etc. ...
  35. Update this list

Post-release management goop

  1. Add URL of Google Groups announcement to the Milestone Memo
    1. Visit the upcxx-announce googlegroup page
    2. Click on the announcement to view it
    3. Click the 🔽 to the right of the message date (says "More message actions" when you roll over)
    4. Select "🔗 Link"
    5. Copy to your clipboard (Ctrl-C or command-C, as appropriate)
    6. Paste into the .docx for the memo
  2. Upload PDF (not .docx) of Milestone Memo as an attachment to Milestone Reports page in Confluence
  3. Add URL for the new Confluence Memo attachment to the footer of Milestone Highlight Slide
  4. Attach PDF (not .pptx) of Milestone Highlight Slide as an attachment to Milestone Reports page in Confluence
  5. Update/add section to Milestone Reports page with links to
    1. JIRA entry in the heading
    2. Memo attachment (uploaded a few steps earlier)
    3. Slide attachment (uploaded a few steps earlier)
    4. Code tarball
    5. Spec PDF
    6. Guide PDF
    7. Google Groups announcement
  6. Perform a second upload of the following two to JIRA Epic as attachments
    1. Milestone Completion Memo PDF
    2. Milestone Highlight Slide PDF
  7. Finish the JIRA Epic by hitting Workflow > Done
  8. Add links to the Confluence-attached Memo to Confluence Quarterly Report page below "Accomplishments / Milestones Delivered During This Period". Past quarters show example.

Updated