Skip to content

releases.rst

Latest commit

 

History

History
112 lines (104 loc) · 5.86 KB

releases.rst

File metadata and controls

112 lines (104 loc) · 5.86 KB
title:Releases
description:The Deis software release process.

Release Checklist

These instructions are to assist the Deis maintainers with creating a new Deis product release. Please keep this document up-to-date with any changes in this process.

deis Repo

  • Create the next deis milestone
  • Move any deis open issues from the current release to the next milestone
  • Close the current deis milestone
  • Update CHANGELOG.md using the changelog script
    • ./contrib/util/generate-changelog.sh vU.V.W vX.Y.Z | cat - CHANGELOG.md > tmp && mv tmp CHANGELOG.md substituting the previous release for vU.V.W and the current one for vX.Y.Z.
    • proofread the new CHANGELOG.md to ensure it was generated correctly
    • git add CHANGELOG.md && git commit -m "docs(CHANGELOG): update for v.X.Y.Z"
  • Merge git master into release branch locally
    • git checkout release && git merge master
  • Edit contrib/coreos/user-data and update DEIS_RELEASE to ":vX.Y.Z"
  • Commit and push the deis/deis release and tag
    • remove "-dev" from __version__ fields in Python packages
    • remove "-dev" from Version constant in version/version.go
    • git commit -a -m 'chore(release): update version to vX.Y.Z'
    • git push origin release
    • git tag vX.Y.Z
    • git push --tags origin vX.Y.Z
  • At the Docker Hub, create an automatic tagged build ":vX.Y.Z" for every component
  • Publish CLI to pypi.python.org
    • cd client && python setup.py sdist upload
    • use testpypi.python.org first to ensure there aren't any problems
  • Continuous delivery jobs at ci.deis.io will update the deis CLI. Double-check that the current binaries are publicly downloadable from the opdemand S3 bucket.
  • Switch master to upcoming release
    • git checkout master
    • update __version__ fields in Python packages to next version + "-dev"
    • update Version constant in version/version.go to next version + "-dev"
    • git commit -a -m 'chore(release): update version to vR.S.T-dev' (next version)
    • git push origin master

deisctl repo

  • Create the next deisctl milestone to match the next deis milestone
  • Move any deisctl open issues from the current release to the next milestone
  • Close the current deisctl milestone
  • Update CHANGELOG.md using the changelog script in the deis project:
    • ../deis/contrib/util/generate-changelog.sh vU.V.W vX.Y.Z | cat - CHANGELOG.md > tmp && mv tmp CHANGELOG.md substituting the previous release for vU.V.W and the current one for vX.Y.Z.
    • proofread the new CHANGELOG.md to ensure it was generated correctly
    • git add CHANGELOG.md && git commit -m "docs(CHANGELOG): update for v.X.Y.Z"
  • Continuous delivery jobs at ci.deis.io will update the deisctl installer. Double-check that the current binaries are publicly downloadable from the opdemand S3 bucket.
  • Commit and push the deis/deisctl release and tag
    • remove "-dev" from the deis-version file in the project root
    • remove "-dev" from the string resource in deisctl.go
    • remove "-dev" from the installer links in README.md
    • git commit -a -m 'chore(release): update version to vX.Y.Z'
    • git push origin master
    • git tag vX.Y.Z
    • git push --tags origin vX.Y.Z
  • Switch master to upcoming release
    • update deis-version file in the project root to next version + "-dev"
    • update Version constant in deisctl.go to next version + "-dev"
    • git commit -a -m 'chore(release): update version to vR.S.T-dev' (next version)
    • git push origin master
  • Update deis.io installer script to point to new -dev version

Documentation

  • (CHANGELOG.md files were regenerated and committed above.)
  • Docs are automatically published to http://docs.deis.io (the preferred alias for deis.readthedocs.org)
  • Log in to the http://deis.readthedocs.org admin
    • add the current release to the list of published builds
    • remove the oldest release from the list of published builds
    • rebuild all published versions so their "Versions" index links are updated
  • Publish docs to pythonhosted.org/deis
    • from the project root, run make -C docs clean zipfile
    • the zipfile will be at docs/docs.zip
    • log in to http://pypi.python.org/ and use the web form at the Deis Pypi page to upload the zipfile
  • Check documentation for deis/* projects at the Docker Hub
    • click "Settings" for each project (deis/controller, deis/cache, etc.)
    • paste the contents of each README.md into the "long description" field if there are discrepencies. (These don't automatically sync up after the Trusted Build is first created.)
  • Create release notes docs
    • follow the format of previous release notes
    • summarize all work done since the previous release
    • visit all opdemand/* and deis/* project issues to make sure we don't miss any contributors for the "Community Shout-Outs" section
    • include "what's next" and "future directions" sections
    • add Markdown version of release notes to deis/deis.io website project