diff --git a/doc/dev/RELEASE_PROCESS.rst b/doc/dev/RELEASE_PROCESS.rst index 3c208adb5..bf23a75d7 100644 --- a/doc/dev/RELEASE_PROCESS.rst +++ b/doc/dev/RELEASE_PROCESS.rst @@ -10,8 +10,8 @@ This document describes the process for creating new releases. ``git push upstream releases/``. 2. **Update the release branch version:** Push a commit that increments the Python - package version in python/ray/__init__.py. You can push this directly to the - release branch. + package version in python/ray/__init__.py and src/ray/raylet/main.cc. You can + push this directly to the release branch. 3. **Update the master branch version:** Create a pull request to increment the version of the master branch, see `this PR`_. @@ -45,16 +45,17 @@ This document describes the process for creating new releases. This will use the autoscaler to start a bunch of machines and run some tests. **Caution!**: By default, the stress tests will require expensive GPU instances. - You'll also want to kick off the long-running tests: + You'll also want to kick off the long-running tests by following the instructions + in: .. code-block:: bash - ray/ci/long_running_tests/start_workloads.sh + ray/ci/long_running_tests/README.rst - You can use the `check_workloads.sh` script to verify the workloads are running. - Let them run for at least 24 hours, and check them again. They should all still - be running (printing new iterations), and their CPU load should be stable when - you view them in the AWS monitoring console (not increasing over time). + Following the instructions to check the status of the workloads to verify that they + are running. Let them run for at least 24 hours, and check them again. They should + all still be running (printing new iterations), and their CPU load should be stable + when you view them in the AWS monitoring console (not increasing over time). 5. **Resolve release-blockers:** If a release blocking issue arises, there are two ways the issue can be resolved: 1) Fix the issue on the master branch and @@ -82,8 +83,8 @@ This document describes the process for creating new releases. pip install -U https://s3-us-west-2.amazonaws.com/ray-wheels/releases/$RAY_VERSION/$RAY_HASH/ray-$RAY_VERSION-cp37-cp37m-macosx_10_6_intel.whl 7. **Upload to PyPI Test:** Upload the wheels to the PyPI test site using - ``twine`` (ask Robert to add you as a maintainer to the PyPI project). You'll - need to run a command like + ``twine`` (ask Robert to add you as a maintainer to the PyPI project on both the + real and test PyPI). You'll need to run a command like .. code-block:: bash @@ -94,10 +95,15 @@ This document describes the process for creating new releases. ``pip``, and that you've created both PyPI accounts. Test that you can install the wheels with pip from the PyPI test repository - with + with: .. code-block:: bash + # First install ray normally because installing from test.pypi.org won't + # be able to install some of the other dependencies. + pip install ray + pip uninstall ray + pip install --index-url https://test.pypi.org/simple/ ray Then start Python, make sure you can ``import ray`` and run some simple Ray @@ -142,19 +148,20 @@ This document describes the process for creating new releases. At the end of the release note, you can add a list of contributors that help creating this release. Use the ``doc/dev/get_contributors.py`` to generate this - list. You will need to create a GitHub token for this task. Example usage: + list. You will need to create a GitHub personal access token first if you don't + have one (github.com -> settings -> developer settings -> personal access tokens). .. code-block:: bash + # Must be run from inside the Ray repository. python get_contributors.py --help python get_contributors.py \ --access-token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx \ - --ray-path=$HOME/ray/ray \ --prev-branch="ray-0.7.1" \ --curr-branch="ray-0.7.2" - Run `ray microbenchmark` to get the latest microbenchmark numbers, and - update their numbers in `profiling.rst`. + Run `ray microbenchmark` on an `m4.16xl` instance running `Ubuntu 18.04` with `Python 3.7` to get the + latest microbenchmark numbers and update them in `profiling.rst`. .. code-block:: bash diff --git a/doc/dev/get_contributors.py b/doc/dev/get_contributors.py index 82399940b..7a5160245 100644 --- a/doc/dev/get_contributors.py +++ b/doc/dev/get_contributors.py @@ -15,8 +15,6 @@ Github Access token that has repo:public_repo and user:read:user permission. Create them at https://github.com/settings/tokens/new """, ) -@click.option( - "--ray-path", required=True, help="File system path to the ray directory") @click.option( "--prev-branch", required=True, @@ -25,10 +23,9 @@ Create them at https://github.com/settings/tokens/new "--curr-branch", required=True, help="Current version branch like ray-0.7.2") -def run(access_token, ray_path, prev_branch, curr_branch): +def run(access_token, prev_branch, curr_branch): # Generate command cmd = [] - cmd.append(f"cd {ray_path}") cmd.append(f'git log {prev_branch}..{curr_branch} --pretty=format:"%s" ' ' | grep -Eo "#(\d+)"') joined = " && ".join(cmd)