Release Process#

This is a guide to the process of creating a new release, and is meant for the maintainers of Raster Vision.

Note

The following instructions assume that Python 3 is the default Python on your local system. Using Python 2 will not work.

Minor or Major Version Release#

  1. It’s a good idea to update any major dependencies before the release.

  2. Test examples:

    1. Checkout the master branch, re-build the docker image (docker/build), and push it to ECR (docker/ecr_publish).

    2. Follow the instructions in this README to do the following:

      1. Run all Examples and check that evaluation metrics are close to the scores from the last release. (For each example, there should be a link to a JSON file with the evaluation metrics from the last release.) This stage often uncovers bugs, and is the most time consuming part of the release process.

      2. Collect all model bundles, and check that they work with the predict command and sanity check output in QGIS.

      3. Update the Model Zoo by uploading model bundles and sample images to the right place on S3. If you use the collect command (see), you should be able to sync the collect_dir to s3://azavea-research-public-data/raster-vision/examples/model-zoo-<version>.

      4. Screenshot the outputs of the compare command (for each example) and include them in the PR described below.

  3. Test notebooks:

    1. Update the tutorial notebooks that use models from the model zoo so that they use the latest version.

    2. Execute all tutorial notebooks and make sure they work correctly. Do not commit output changes unless code behavior has changed.

  4. Test/update docs:

    1. Update the docs if needed. See the docs README for instructions.

    2. Update tiny_spacenet.py if needed and ensure the line numbers in every literalinclude of that file are correct. Tip: you can find all instances by searching the repo using the regex: \.\. literalinclude:: .+tiny_spacenet\.py$.

    3. Test Installation and Quickstart instructions and make sure they work.

    4. Test examples from Writing pipelines and plugins.

      rastervision run inprocess rastervision.pipeline_example_plugin1.config1 -a root_uri /opt/data/pipeline-example/1/ --splits 2
rastervision run inprocess rastervision.pipeline_example_plugin1.config2 -a root_uri /opt/data/pipeline-example/2/ --splits 2
rastervision run inprocess rastervision.pipeline_example_plugin2.config3 -a root_uri /opt/data/pipeline-example/3/ --splits 2

    5. Test examples from Bootstrap new projects with a template.

      cookiecutter /opt/src/cookiecutter_template

    6. Update the the changelog, and point out API changes.

    7. Fix any broken badges on the GitHub repo readme.

  5. Update the version number. This occurs in several places, so it’s best to do this with a find-and-replace over the entire repo.

  6. Make a PR to the master branch with the preceding updates. In the PR, there should be a link to preview the docs. Check that they are building and look correct.

  7. Make a git branch with the version as the name, and push to GitHub.

  8. Ensure that the docs are building correctly for the new version branch on readthedocs. You will need to have admin access on your RTD account. Once the branch is building successfully, Under Versions -> Activate a Version, you can activate the version to add it to the sidebar of the docs for the latest version. (This might require manually triggering a rebuild of the docs.) Then, under Admin -> Advanced Settings, change the default version to the new version.

  9. GitHub Actions is supposed to publish an image whenever there is a push to a branch with a version number as the name. If this doesn’t work or you want to publish it immediately, then you can manually make a Docker image for the new version and push to Quay. For this you will need an account on Quay.io under the Azavea organization.

    ./docker/build
docker login quay.io
docker tag raster-vision-pytorch:latest quay.io/azavea/raster-vision:pytorch-<version>
docker push quay.io/azavea/raster-vision:pytorch-<version>

  10. Make a GitHub tag and release using the previous release as a template.

  11. Publish all packages to PyPI. This step requires twine which you can install with

    pip install twine

    To store settings for PyPI you can setup a ~/.pypirc file containing:

    [pypi]
username = azavea

    Once packages are published they cannot be changed so be careful. (It’s possible to practice using testpypi.) Navigate to the raster-vision repo on your local filesystem. With the version branch checked out, run something like the following to publish each plugin, and then the top-level package.

    export RV="/Users/lfishgold/projects/raster-vision"

    cd $RV/rastervision_pipeline
python setup.py sdist bdist_wheel
twine upload dist/*

    cd $RV/rastervision_aws_batch
python setup.py sdist bdist_wheel
twine upload dist/*

    cd $RV/rastervision_aws_s3
python setup.py sdist bdist_wheel
twine upload dist/*

    cd $RV/rastervision_core
python setup.py sdist bdist_wheel
twine upload dist/*

    cd $RV/rastervision_pytorch_learner
python setup.py sdist bdist_wheel
twine upload dist/*

    cd $RV/rastervision_pytorch_backend
python setup.py sdist bdist_wheel
twine upload dist/*

    cd $RV/rastervision_gdal_vsi
python setup.py sdist bdist_wheel
twine upload dist/*

    cd $RV
python setup.py sdist bdist_wheel
twine upload dist/*

  12. Announce new release in our forum, and with blog post if it’s a big release.

  13. Make a PR to the master branch that updates the version number to the next development version. For example, if the last release was 0.20.1, update the version to 0.20.2-dev.

Bug Fix Release#

This describes how to create a new bug fix release, using incrementing from 0.8.0 to 0.8.1 as an example. This assumes that there is already a branch for a minor release called 0.8.

  1. To create a bug fix release (version 0.8.1), we need to backport all the bug fix commits on the master branch that have been added since the last bug fix release onto the 0.8 branch. For each bug fix PR on master, we need to create a PR against the 0.8 branch based on a branch of 0.8 that has cherry-picked the commits from the original PR. The title of the PR should start with [BACKPORT].

  2. Make and merge a PR against 0.8 (but not master) that increments the version in each setup.py file to 0.8.1. Then wait for the 0.8 branch to be built by GitHub Actions and the 0.8 Docker images to be published to Quay. If that is successful, we can proceed to the next steps of actually publishing a release.

  3. Using the GitHub UI, make a new release. Use 0.8.1 as the tag, and the 0.8 branch as the target.

  4. Publish the new version to PyPI. Follow the same instructions for PyPI that are listed above for minor/major version releases.