Script to release ok-client #288

knrafto · 2017-03-01T20:47:31Z

Resolves #264, #276.

Test plan:

Clone into a new github repo for testing
Comment out the python setup.py sdist upload
Edit GITHUB_REPO to point to the testing repo
Edit OK_SERVER_URL to point to localhost:5000
Try to "release" the fake client. Should see
- Version bump pushed to github
- GitHub release with correct binary
- Updated client version on localhost:5000

This reverts commit cdb9082.

knrafto · 2017-03-04T00:24:11Z

It works https://github.com/okpy/ok-client/releases/tag/v1.10.3

Feel free to try it out there. You'll need to have the server running locally.

Sumukh

I haven't tried it but it looks good. I'll try it out soon

Sumukh · 2017-03-04T02:36:36Z

README.md

-   contains okpy's Pypi credentials.
-3. From the base of the repo, make sure your virtualenv is activated and run
+* Your virtualenv is activated and you are on the master branch.
+* Your `~/.pypirc` contains okpy's PyPI credentials.


If this is supposed to be a checklist - something about double checking that tests have passed would probably be good.

The tests only take a few seconds, so I'll just add that to the script's sanity checks.

Sumukh · 2017-03-04T02:37:18Z

README.md

-3. From the base of the repo, make sure your virtualenv is activated and run
+* Your virtualenv is activated and you are on the master branch.
+* Your `~/.pypirc` contains okpy's PyPI credentials.
+* A file `.github-token` contains a [GitHub access token](https://help.github.com/articles/creating-an-access-token-for-command-line-use/).


What scopes/permissions does the token need? (It's fine to just say select all of them)

Sumukh · 2017-03-04T02:42:42Z

release.py

+        )
+
+    print('Updating version on {}...'.format(OK_SERVER_URL))
+    # Create a fake assignment to log in. I'm not happy about this


Out of scope for this PR: Getting a token seems like the one thing we should be able to support without an assignment. Maybe we should add a method somewhere that accepts all of the default values.

I've opened up a URL in other scripts - but I don't recommend it for this file.

def get_token(): print("Get an access token for your OK account & paste it below") webbrowser.open('https://ok-oauth.app.cs61a.org/') return input("Your OK Token: ").strip()

Sumukh · 2017-03-04T02:45:01Z

release.py

+    try:
+        output = subprocess.run(command, **kwargs)
+    except subprocess.CalledProcessError as e:
+        print(str(e))


Curious: Any reason this isn't going into sys.stderr? (I'm ambivalent about where it goes)

Sumukh · 2017-03-04T04:21:26Z

This doesn't use the virtualenv python and my python3 is at /usr/local/bin/python3
It also seems like some kind of virtualenv bug & python3.6 (See issue 962 in https://github.com/pypa/virtualenv)

Being able to use python (or python3) release.py directly would be nice so that isn't as much of an issue for other people. Currently we can't because

  File "release.py", line 73, in <module>
    os.chdir(os.path.dirname(__file__))
FileNotFoundError: [Errno 2] No such file or directory: ''

I actually haven't been able to get the script smoothly because of the python issues (and the virtualenv issues). I did get to upload a release though.

Sanity check to keep the version number starting with v1. instead of just v
If we want to change the major version I think it's reasonable to change the release script. It would be super easy for me to accidentally release v11.02 instead of v1.10.2

Sumukh · 2017-03-04T04:22:28Z

Also I think there's a dependence on running python3 setup.py develop to get the ok-publish command going if it wasn't before.

From the diff it seems like that part hasn't been added?

knrafto · 2017-03-04T23:28:57Z

This does use the virtualenv python3. usr/bin/env python3 invokes the first executable named python3 on your PATH, which will be the virtualenv python3 if you've activated it. I've fixed running just python3 release.py though.

I don't want to hardcode v1., since it's conceivable that we'll want to release version 2 sometime. How about the major version number should not increase by more than 1?

Sumukh · 2017-03-04T23:30:46Z

I don't want to hardcode v1., since it's conceivable that we'll want to release version 2 sometime. How about the major version number should not increase by more than 1?

Sure.

knrafto · 2017-03-04T23:40:47Z

I think I've addressed everything. Any other concerns before I merge?

Sumukh · 2017-03-04T23:41:14Z

Nope - feel free to merge & then release with this script :)

knrafto added 2 commits March 1, 2017 12:48

First iteration of release script

ef254ce

Authenticate to OK

25e2e7e

knrafto force-pushed the release branch from d78cc4f to 25e2e7e Compare March 1, 2017 20:48

knrafto added 14 commits March 3, 2017 15:44

Comment out pypi upload; change ok server and repo locations

cdb9082

Fix API auth

cc5e947

git pull --ff-only

9d39671

Simplify shell function args

ee6107b

Use OK_SERVER_DOMAIN in print

5909664

Include protocol in server_url

78ed063

Print ERROR: on failure

2e8999e

args -> cmd_args

55a4880

Echo post requests

92ec360

Fix version endpoint

e82624e

setup.py develop should be run once

11a75bd

Better reminder to update requirements.txt

d72ae1f

Revert "Comment out pypi upload; change ok server and repo locations"

0d4e098

This reverts commit cdb9082.

Update README with new release instructions

b3b2ff6

Sumukh reviewed Mar 4, 2017

View reviewed changes

knrafto added 4 commits March 3, 2017 19:12

Remove unused line

acd2f36

Print subprocess failure to stderr

4610538

Token needs "repo" scope

cf84285

Upload wheels to PyPI

06453f7

knrafto added 2 commits March 4, 2017 15:25

python setup.py develop before ok-publish

0f78373

Get real path of file

d257474

Major version cannot increase by more than one

4a2cb82

Run tests before release

ff4df97

knrafto merged commit fcf2877 into master Mar 4, 2017

knrafto deleted the release branch March 4, 2017 23:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Script to release ok-client #288

Script to release ok-client #288

knrafto commented Mar 1, 2017 •

edited

Loading

knrafto commented Mar 4, 2017

Sumukh left a comment

Sumukh Mar 4, 2017 •

edited

Loading

knrafto Mar 4, 2017

Sumukh Mar 4, 2017

Sumukh Mar 4, 2017

Sumukh Mar 4, 2017

Sumukh commented Mar 4, 2017 •

edited

Loading

Sumukh commented Mar 4, 2017

knrafto commented Mar 4, 2017

Sumukh commented Mar 4, 2017

knrafto commented Mar 4, 2017

Sumukh commented Mar 4, 2017 •

edited

Loading

Script to release ok-client #288

Script to release ok-client #288

Conversation

knrafto commented Mar 1, 2017 • edited Loading

knrafto commented Mar 4, 2017

Sumukh left a comment

Choose a reason for hiding this comment

Sumukh Mar 4, 2017 • edited Loading

Choose a reason for hiding this comment

knrafto Mar 4, 2017

Choose a reason for hiding this comment

Sumukh Mar 4, 2017

Choose a reason for hiding this comment

Sumukh Mar 4, 2017

Choose a reason for hiding this comment

Sumukh Mar 4, 2017

Choose a reason for hiding this comment

Sumukh commented Mar 4, 2017 • edited Loading

Sumukh commented Mar 4, 2017

knrafto commented Mar 4, 2017

Sumukh commented Mar 4, 2017

knrafto commented Mar 4, 2017

Sumukh commented Mar 4, 2017 • edited Loading

knrafto commented Mar 1, 2017 •

edited

Loading

Sumukh Mar 4, 2017 •

edited

Loading

Sumukh commented Mar 4, 2017 •

edited

Loading

Sumukh commented Mar 4, 2017 •

edited

Loading