Updates release documentation by AndreMiras · Pull Request #2177 · kivy/python-for-android

AndreMiras · 2020-05-07T21:36:20Z

Links both Travis and GitHub CI build systems
Updates the PyPI release process (handled by the CI)

AndreMiras · 2020-05-07T21:37:17Z

Also one point I'd like to discuss.
In the checklist we used the markdown format, but the documentation is restructured text. So I'm not sure what we want here. Do we want it as a code block so it can be copy pasted in each GitHub release PR or do we want it to be properly rendered in rst format?
https://github.com/kivy/python-for-android/blob/2b33eae/doc/source/contribute.rst#release-checklist

opacam · 2020-05-09T01:16:45Z

doc/source/contribute.rst

 - [ ] Build and run the [on_device_unit_tests](https://github.com/kivy/python-for-android/tree/master/testapps/on_device_unit_tests) app using buildozer. Check that they all pass.
 - [ ] Build and run the following [testapps](https://github.com/kivy/python-for-android/tree/master/testapps) for arch `armeabi-v7a` and `arm64-v8a`:
-  - `python3 setup_testapp_python3_sqlite_openssl.py apk`
+  - [ ] `python3 setup_testapp_python3_sqlite_openssl.py apk`
    - [ ] `armeabi-v7a`
    - [ ] `arm64-v8a`
 - [ ] Check that the version number is correct


I would modify these lines, since, IMHO, the on_device_unit_tests app has the same functionality than testapp_python3_sqlite_openssl plus a little more (we can check device orientation,if service is working, kivy's keyboard options...). So, I would suggest to test on_device_unit_tests, because we also could avoid to do the local build (since we have it done in an isolated system with github actions). Still, I would put the command needed to perform a local build for a given arch, just in case that github actions fails or who knows...

Also I would suggest to put the command relative to the project (not inside testapps) since I think that, if you take an programming IDE like pycharm, the default terminal path is at project level, so it will make easier to copy/paste the command and run it from inside an IDE without entering the testapps directory. Also I think that is more explicit.

- [ ] Build (or download from github actions) and run the following [testapps](https://github.com/kivy/python-for-android/tree/master/testapps/on_device_unit_tests) for arch `armeabi-v7a` and `arm64-v8a`: - [ ] on_device_unit_tests - [ ] `armeabi-v7a` (cmd: `python3 testapps/on_device_unit_tests/setup.py --arch=armeabi-v7a --debug`) - [ ] `arm64-v8a` (cmd: `python3 testapps/on_device_unit_tests/setup.py --arch=arm64-v8a --debug`)

Anyhow, I would suggest to have @inclement approval for the suggested changes I made (he has far better vision than mine and this is very sensitive stuff...), for your changes, no problem at all,so you have my approval.

Thanks 😄

AndreMiras · 2020-05-09T09:08:10Z

Thanks @opacam I've addressed your comments.
I also decided to fix the rendering to really be reStructuredText so it renders OK in our docs. See how it renders on my fork vs how it renders currently

opacam · 2020-05-09T10:36:29Z

doc/source/contribute.rst

+    - [ ] `armeabi-v7a` (cmd: `python3 testapps/on_device_unit_tests/setup.py  --arch=armeabi-v7a --debug`)
+
+    - [ ] `arm64-v8a` (cmd: `python3 testapps/on_device_unit_tests/setup.py  --arch=arm64-v8a --debug`)


Mmmm..my mistake in here, I realized that I gived to you a wrong command, sorry 😬, this is more appropiated:

Suggested change

- [ ] `armeabi-v7a` (cmd: `python3 testapps/on_device_unit_tests/setup.py --arch=armeabi-v7a --debug`)

- [ ] `arm64-v8a` (cmd: `python3 testapps/on_device_unit_tests/setup.py --arch=arm64-v8a --debug`)

- [ ] `armeabi-v7a`::

cd testapps/on_device_unit_tests && PYTHONPATH=.:../../ python3 setup.py apk --ndk-dir=<your-ndk-dir> --sdk-dir=<your-sdk-dir> --arch=armeabi-v7a --debug

- [ ] `arm64-v8a`::

cd testapps/on_device_unit_tests && PYTHONPATH=.:../../ python3 setup.py apk --ndk-dir=<your-ndk-dir> --sdk-dir=<your-sdk-dir> --arch=arm64-v8a --debug

I actually had some doubt as I thought I tried in the past with cd-ing and we couldn't.
Anyway, now I'm think we should maybe keep this simple and not give the command example at all

I like including the command example because the intention of this doc is to make preparing a release as absolutely thoughtless as possible. Perhaps it would be nice to move it to a makefile command that builds the release targets and prints some clear information about where they were output (but of course don't feel the need to do that here).

Ei guys I fixed the command: PYTHONPATH should include p4a sources and testapp sources:

PYTHONPATH=.:../../

That is why didn't work for you @AndreMiras

inclement

Looks good to me. The reason for using markdown-style formatting was indeed so that it can easily be pasted across, but having it look right is good. I guess we could alternatively use markdown formatting but code-format the whole thing, or just make a github template for it (I believe different issue templates are possible via url parameters?)

inclement · 2020-05-09T10:46:17Z

doc/source/contribute.rst

+    - [ ] `armeabi-v7a` (cmd: `python3 testapps/on_device_unit_tests/setup.py  --arch=armeabi-v7a --debug`)
+
+    - [ ] `arm64-v8a` (cmd: `python3 testapps/on_device_unit_tests/setup.py  --arch=arm64-v8a --debug`)


I like including the command example because the intention of this doc is to make preparing a release as absolutely thoughtless as possible. Perhaps it would be nice to move it to a makefile command that builds the release targets and prints some clear information about where they were output (but of course don't feel the need to do that here).

opacam

Thanks!!

AndreMiras · 2020-05-09T10:54:57Z

Thanks guys for the feedback.
Indeed @inclement I thought maybe that would be it regarding the markdown, so let's code format it instead.
Good idea for the issue template. Things is most of the issues we create are not for releasing and users creating bugs would get even more confused with the process 😄
Anyway, I'll put back the examples as suggested by @opacam if you both like it and also format it to code block so it can be copy pasted

inclement · 2020-05-09T10:56:17Z

@AndreMiras I haven't looked at this much before, but it looks here like the template would just be a dropdown option, which would be quite clear.

AndreMiras · 2020-05-09T10:59:48Z

Yeah I will give it a try then. But using triple backquotes when sharing the bug log is not that complex, yet most of bug reports don't have it. Same thing for avoiding duplicated bugs creation 😅
I'll update this PR still and look into the release creation one later

- Updates the PyPI release process (handled by the CI) - Links both Travis and GitHub CI build systems - Reformats the release checklist to blockcode for markdown

opacam

LGTM, thanks again!!

AndreMiras · 2020-05-09T14:30:27Z

I won't look into the dedicated issue template just now. So let's merge this minor improvement until we try out for a better solution

opacam previously approved these changes May 9, 2020

View reviewed changes

AndreMiras dismissed opacam’s stale review via 3d516b3 May 9, 2020 09:04

AndreMiras force-pushed the feature/release_documentation_update branch from 09380ee to 3d516b3 Compare May 9, 2020 09:04

AndreMiras requested a review from opacam May 9, 2020 10:33

opacam reviewed May 9, 2020

View reviewed changes

AndreMiras force-pushed the feature/release_documentation_update branch from 3d516b3 to 267b368 Compare May 9, 2020 10:44

inclement previously approved these changes May 9, 2020

View reviewed changes

opacam previously approved these changes May 9, 2020

View reviewed changes

Updates release documentation

afa99bb

- Updates the PyPI release process (handled by the CI) - Links both Travis and GitHub CI build systems - Reformats the release checklist to blockcode for markdown

AndreMiras dismissed stale reviews from opacam and inclement via afa99bb May 9, 2020 11:03

AndreMiras force-pushed the feature/release_documentation_update branch from 267b368 to afa99bb Compare May 9, 2020 11:03

opacam approved these changes May 9, 2020

View reviewed changes

AndreMiras merged commit f3e9222 into kivy:develop May 9, 2020

AndreMiras deleted the feature/release_documentation_update branch May 9, 2020 14:30

Dirk-Sandberg mentioned this pull request May 9, 2020

Setting p4a.source_dir in buildozer causes AttributeError: module 'build' has no attribute 'parse_args_and_make_package' #2149

Closed

		- [ ] `armeabi-v7a` (cmd: `python3 testapps/on_device_unit_tests/setup.py --arch=armeabi-v7a --debug`)

		- [ ] `arm64-v8a` (cmd: `python3 testapps/on_device_unit_tests/setup.py --arch=arm64-v8a --debug`)

-    - [ ] `armeabi-v7a` (cmd: `python3 testapps/on_device_unit_tests/setup.py  --arch=armeabi-v7a --debug`)
-    - [ ] `arm64-v8a` (cmd: `python3 testapps/on_device_unit_tests/setup.py  --arch=arm64-v8a --debug`)
+    - [ ] `armeabi-v7a`::
+          cd testapps/on_device_unit_tests && PYTHONPATH=.:../../ python3 setup.py apk  --ndk-dir=<your-ndk-dir> --sdk-dir=<your-sdk-dir> --arch=armeabi-v7a --debug
+    - [ ] `arm64-v8a`::
+          cd testapps/on_device_unit_tests && PYTHONPATH=.:../../ python3 setup.py apk  --ndk-dir=<your-ndk-dir> --sdk-dir=<your-sdk-dir> --arch=arm64-v8a --debug

Conversation

AndreMiras commented May 7, 2020

Uh oh!

AndreMiras commented May 7, 2020

Uh oh!

opacam May 9, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AndreMiras commented May 9, 2020

Uh oh!

opacam May 9, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AndreMiras May 9, 2020

Choose a reason for hiding this comment

Uh oh!

inclement May 9, 2020

Choose a reason for hiding this comment

Uh oh!

opacam May 9, 2020

Choose a reason for hiding this comment

Uh oh!

inclement left a comment

Choose a reason for hiding this comment

Uh oh!

inclement May 9, 2020

Choose a reason for hiding this comment

Uh oh!

opacam left a comment

Choose a reason for hiding this comment

Uh oh!

AndreMiras commented May 9, 2020

Uh oh!

inclement commented May 9, 2020

Uh oh!

AndreMiras commented May 9, 2020

Uh oh!

opacam left a comment

Choose a reason for hiding this comment

Uh oh!

AndreMiras commented May 9, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

opacam May 9, 2020 •

edited

Loading

opacam May 9, 2020 •

edited

Loading