Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve release process 0.7.2 #5187

Merged
merged 6 commits into from
Jul 15, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions ci/stress_tests/run_application_stress_tests.sh
Original file line number Diff line number Diff line change
Expand Up @@ -148,10 +148,9 @@ test_sgd(){
}

# RUN TESTS
for PYTHON_VERSION in "p27" "p36"
for PYTHON_VERSION in "p36"
do
test_impala $PYTHON_VERSION
test_sgd $PYTHON_VERSION
done

cat "$RESULT_FILE"
Expand Down
30 changes: 19 additions & 11 deletions dev/RELEASE_PROCESS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ This document describes the process for creating new releases.

and make sure they pass. If they pass, it will be obvious that they passed.
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.

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
Expand All @@ -63,13 +64,7 @@ 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-cp36-cp36m-macosx_10_6_intel.whl
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. **Final Testing:** Send a link to the wheels to the other contributors and
core members of the Ray project. Make sure the wheels are tested on Ubuntu
and MacOS (ideally multiple versions of Ubuntu and MacOS). This testing
should verify that the wheels are correct and that all release blockers have
been resolved. Should a new release blocker be found, repeat steps 5-7.

8. **Upload to PyPI Test:** Upload the wheels to the PyPI test site using
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

Expand All @@ -95,7 +90,7 @@ This document describes the process for creating new releases.
Do this at least for MacOS and for Linux, as well as for Python 2 and Python
3.

9. **Upload to PyPI:** Now that you've tested the wheels on the PyPI test
8. **Upload to PyPI:** Now that you've tested the wheels on the PyPI test
repository, they can be uploaded to the main PyPI repository. Be careful,
**it will not be possible to modify wheels once you upload them**, so any
mistake will require a new release. You can upload the wheels with a command
Expand All @@ -114,7 +109,7 @@ This document describes the process for creating new releases.
finds the correct Ray version, and successfully runs some simple scripts on
both MacOS and Linux as well as Python 2 and Python 3.

10. **Create a GitHub release:** Create a GitHub release through the
9. **Create a GitHub release:** Create a GitHub release through the
`GitHub website`_. The release should be created at the commit from the
previous step. This should include **release notes**. Copy the style and
formatting used by previous releases. Create a draft of the release notes
Expand All @@ -127,7 +122,20 @@ This document describes the process for creating new releases.
git pull origin master --tags
git log $(git describe --tags --abbrev=0)..HEAD --pretty=format:"%s" | sort

11. **Update version numbers throughout codebase:** Suppose we just released

At the end of the release note, you can add a list of contributors that help
creating this release. Use the ``dev/get_contributors.py`` to generate this
list. You will need to create a GitHub token for this task. Example usage:

.. code-block:: bash
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"

10. **Update version numbers throughout codebase:** Suppose we just released
0.7.1. The previous release version number (in this case 0.7.0) and the
previous dev version number (in this case 0.8.0.dev0) appear in many places
throughout the code base including the installation documentation, the
Expand All @@ -137,7 +145,7 @@ This document describes the process for creating new releases.
should be replaced. For example, ``0.7.0`` appears in this file but should
not be updated.

12. **Improve the release process:** Find some way to improve the release
11. **Improve the release process:** Find some way to improve the release
process so that whoever manages the release next will have an easier time.

.. _`this example`: https://github.com/ray-project/ray/pull/4226
Expand Down
65 changes: 65 additions & 0 deletions dev/get_contributors.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
from github import Github
from subprocess import check_output
import shlex
from tqdm import tqdm
import click


@click.command()
@click.option(
"--access-token",
required=True,
help="""
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,
help="Previous version branch like ray-0.7.1")
@click.option(
"--curr-branch",
required=True,
help="Current version branch like ray-0.7.2")
def run(access_token, ray_path, 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)
cmd = f"bash -c '{joined}'"
cmd = shlex.split(cmd)
print("Executing", cmd)

# Sort the PR numbers
pr_numbers = [
int(l.lstrip("#")) for l in check_output(cmd).decode().split()
]
print("PR numbers", pr_numbers)

# Use Github API to fetch the
g = Github(access_token)
ray_repo = g.get_repo("ray-project/ray")
logins = set()
for num in tqdm(pr_numbers):
try:
logins.add(ray_repo.get_pull(num).user.login)
except Exception as e:
print(e)

print()
print("Here's the list of contributors")
print("=" * 10)
print()
print("@" + ", @".join(logins))
print()
print("=" * 10)


if __name__ == "__main__":
run()