Skip to content

ReleaseProcedure

PHHargrove edited this page Mar 28, 2018 · 83 revisions
  1. Update UPCXX_VERSION version number 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
  2. Update version info in utils/upcxx-run:load_args()
  3. Update ChangeLog + version info in README
  4. Update nobs default URL to point at EX release tarball
  5. Commit final guide PDF to docs/guide.pdf
    1. upload to upcxx/upcxx downloads area with name like upcxx-guide-2017.9.0.pdf
    2. TAG the guide repo
  6. Commit final spec PDF to docs/spec.pdf
    1. upload to upcxx/upcxx downloads area with name like upcxx-spec-V1.0-Draft4.pdf
    2. TAG the spec repo
  7. Generate source release-candidate tarball (from git working dir)
    Be sure to change version in the following:
    git archive --remote=origin develop --prefix=upcxx-2017.9.0/ --format=tar.gz --output=upcxx-2017.9.0.tar.gz Upload this release candidate to (private) berkeleylab/upcxx downloads area
  8. Email local group to review the release-candidate
  9. Ask an ADMIN to grant you WRITE access to the 'master' branch
  10. 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
  11. Ask an ADMIN to revoke WRITE access to the 'master' branch
  12. 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
  13. Generate final tarball
    Same command as release candidate except "master" replaces "develop"
    Be sure to change version in the following:
    git archive --remote=origin master --prefix=upcxx-2017.9.0/ --format=tar.gz --output=upcxx-2017.9.0.tar.gz
    Upload this final release to (public) upcxx/upcxx downloads area
  14. Advance patch version number on develop branch in src/upcxx.hpp
  15. Advance draft number and append ".dev" suffix on spec master branch in upcxx-spec.tex
  16. Change nobs URL back to collaborator-snapshot on develop
  17. Review and revise the release announcement
  18. Navigate to the wiki and git clone it to your local system
  19. Add any new publications (eg updated spec or guide) to wiki/Publications.md and wiki/pubs/*.pdf
  20. Update all 3 issue trackers: add this release to Versions, next one to Milestones and as default Milestone
  21. Update Download section of wiki/Home.md with info on the new release download including links
  22. Update wiki/{README.md,INSTALL.md,docs/*} with files from the release, overwriting the version there. Be sure to audit these changes before committing to look for information loss.
  23. Audit {README,INSTALL}.md for links within the source tree (which will be broken on wiki) and de-link them
    1. Currently known:
    2. INSTALL.md: example/prog-guide/Makefile
    3. Update this list after each audit
  24. Push your wiki changes and audit everything on the live page, especially checking for broken links.
  25. Add md5sum of each download (code, guide, spec) to announcement
  26. Send the announcement

Post-release management goop

  1. Add URL of Google Groups announcement to the Milestone Memo
    1. Visit the upcxx 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: 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.

Clone this wiki locally