[MAJOR] Gradle upgrade from 4.10.3 to 6.x #792

breautek · 2019-07-24T00:04:16Z

Platforms affected

Android

Motivation and Context

Updates gradle version to the latest release (currently 6.1). It solves a few issue tickets that supposedly was caused after upgrading Android Studio.

Fixes #780
Fixes #754
Fixes #718
Fixes #834

Description

Changed the desired gradle version from 4.10.3 to 6.1

Testing

I have tested using npm test and all tests passed. Note that if you have ran npm test before, you will need to remove the /test/gradlew file so the test project will download the new gradle version.

I have also tested by creating a brand new cordova app, and adding the cordova-android platform by using cordova platform add https://github.com/breautek/cordova-android.git#gradle-5.x
Then running the cordova build android command.

I'd also like to make a note that gradle 5.5.1 does currently produce a warning stating:

Deprecated Gradle features were used in this build, making it incompatible with Gradle 6.0.

Running gradlew manually with --verbose --stacktrace shows the code triggering the warning is android internal code.

Checklist

I've run the tests to see all new and existing tests pass
I added automated test coverage as appropriate for this change
Commit is prefixed with (platform) if this change only applies to one platform (e.g. (android))
If this Pull Request resolves an issue, I linked to the issue in the text above (and used the correct keyword to close issues using keywords)
I've updated the documentation if necessary

breautek · 2019-07-24T00:06:09Z

This PR is intended for the android 9.x milestone.

codecov-io · 2019-07-24T01:14:13Z

Codecov Report

Merging #792 into master will not change coverage.
The diff coverage is 0%.

@@           Coverage Diff           @@
##           master     #792   +/-   ##
=======================================
  Coverage   66.17%   66.17%           
=======================================
  Files          19       19           
  Lines        1839     1839           
=======================================
  Hits         1217     1217           
  Misses        622      622

Impacted Files	Coverage Δ
...lates/cordova/lib/config/GradlePropertiesParser.js	`76.66% <ø> (ø)`	⬆️
...n/templates/cordova/lib/builders/ProjectBuilder.js	`67.42% <0%> (ø)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 64ef13c...9595ba9. Read the comment docs.

janpio · 2019-07-24T06:22:33Z

Note that if you have ran npm test before, you will need to remove the /test/gradlew file so the test project will download the new gradle version.

We should open an issue for this so this can get fixed.

I'd also like to make a note that gradle 5.5.1 does currently produce a warning stating:

Deprecated Gradle features were used in this build, making it incompatible with Gradle 6.0.

Running gradlew manually with --verbose --stacktrace shows the code triggering the warning is android internal code.

So nothing we can do about?

breautek · 2019-07-24T23:57:08Z

So nothing we can do about?

Not really. There is an open bug ticket on Android Issue Tracker.

We should open an issue for this so this can get fixed.

I could just add an npm script to do this for you, so that we can just use something like npm run-script clean.

erisu · 2019-07-25T03:22:28Z

I think git clean -fdx should be enough as well. This is typically what I use to clean out any left over files and folder that are untracked.

breautek · 2019-07-30T00:45:23Z

I think git clean -fdx should be enough as well. This is typically what I use to clean out any left over files and folder that are untracked.

Actually ran into an issue on "cleaning" gradlew as I was writing the script I remembered that not everybody is going to be running in a bash environment...

I think windows have different commands for using rm and I don't think they support the && syntax in their command line to run another command immediately after the first command... (could be wrong, been forever since I used windows...)

using git clean -fdx will also remove node_modules, which will require using npm install again, so if I used this, I'd still have to run a second command and run into the issue described above.

So I think the best way to handle this is to use a task system such as gulp or grunt so the clean code can be ran in Node, allowing more cross-platform flexibility. Currently the repository doesn't have either and I'm not sure if such systems are okay in Cordova, or if it is, if one is preferred over the other.

erisu · 2019-07-30T01:56:32Z

I don't think they support the && syntax in their command line to run another command immediately after the first command

&& is supported and runs only if the first command was successful. Last I tested.

using git clean -fdx will also remove node_modules, which will require using npm install again, so if I used this, I'd still have to run a second command and run into the issue described above.

git clean -fdx -e node_modules

cross-platform flexibility

The command above should work on all platforms: linux, macOS (tested), and Windows (tested).

breautek · 2019-08-01T00:05:55Z

I've added a clean script that does git clean -fdx -e node_modules. I run linux and it works excellent for this case as well. Thanks for the suggestion!

So anybody with existing repositories can now simply run npm run clean and it will remove gradle and other build artefacts. I don't call this automatically as I think that might be rather annoying having gradle be redownloaded/redeployed everytime running npm test.

Kevin-Hamilton · 2019-08-08T21:21:37Z

This assumes 1) that the project is currently being managed under git, and 2) that the developer does not have any untracked or uncommitted work anywhere in the current git repository (which may be tracking files and folders beyond the scope of the package.json that this command is in).

I think this is a bad idea. Unless I am misunderstanding the target user for the npm run clean command?

breautek · 2019-08-08T22:17:39Z

The clean command is something that a developer would use when working in the cordova-android repo. It's not intended to be used as a part of a broad script.

However, there is some annoying dangers. I've incorporated using git clean in my workflow in another project and accidentally deleted newly added but untracked files.

So maybe just writing a gulp script might be better, to avoid accidents like that.

breautek · 2019-09-09T00:14:31Z

@erisu FYI, I opted away from the git clean method as you suggested. I originally liked the idea and even used it my own personal project. However, I had a situation where I accidentally deleted untracked files that was intended to added to the repo because git clean was ran as a part of a script.

Due to this danger I decided to replace it with a gulpfile implementation. I see that gulp is already used in the cordova-docs library, so I assume it wouldn't be a big deal adding a dev dependency here. The gulpfile contains a clean task to clean files that we need to specifically clean, which is currently ./test/gradlew && ./test/gradlew.bat.

package.json

timbru31

LGTM! I'd like another maintainer to have a look, too, though. :)

breautek · 2019-09-24T00:19:33Z

LGTM! I'd like another maintainer to have a look, too, though. :)

This PR is intended for 9.x, perhaps a branch should be created on the apache repo for 9.x? Currently this PR is actually targeting apache's master.

brodycj · 2019-09-24T00:41:03Z

LGTM for 9.0. I did verify from [1] that this proposal is referencing the most recent Gradle version to date.

Here are my personal feelings:

I would downvote making a new branch for 9.x due to the potential for confusion and extra merging that may be needed as a consequence.
I would favor committing this change now and maybe using cordova-coho to set the version to 9.0.0-dev. Then 8.x patch releases could still be made from the existing 8.1.x branch, if needed.

I wonder if we should discuss in [email protected] before merging?

[1] https://services.gradle.org/distributions/

erisu

LGTM 👍

breautek · 2019-09-24T01:06:03Z

I would favor committing this change now and maybe using cordova-coho to set the version to 9.0.0-dev. Then 8.x patch releases could still be made from the existing 8.1.x branch, if needed.

This works for me.

erisu · 2019-09-24T01:09:50Z

I do not recommend merging this PR into master until we are ready to prepare the next major release. There is no official release date and from various discussions is looking to be more around mid-January to early February. It is better to keep master available for potential future minor or patch releases until then.

breautek · 2019-11-14T16:44:37Z

Note to myself: #834 (comment) may be affected by this PR. I should double check this.

piotr-cz · 2019-11-14T20:42:22Z

Gradle 6.0 is out.
I wonder if there is a B/C coming anyway maybe it's worth to skip to latest Gradle version?

breautek · 2019-11-14T20:58:15Z

Gradle 6.0 is out.
I wonder if there is a B/C coming anyway maybe it's worth to skip to latest Gradle version?

Definitely worth looking into.

bin/templates/project/app/build.gradle

bin/templates/project/build.gradle

test/build.gradle

…ore fine control over which files needing to be 'cleaned'

…lean test gradle installation

Upgraded android gradle plugin to version 3.5.2 (current stable) Removed useDeprecatedNdk as this option is now completely removed from gradle.

erisu

I performed the following test.

cordova create testApp
cordova platform add github:breautek/cordova-android\#gradle-5.x
cordova build android
cordova run android

I also opened the project in Android Studio and the Android project synced successfully with out any errors or warnings. As a side note, it is always recommended to build the application once with the cordova run build command before opening the projects platforms/android directory in Android Studio so it can checkout Gradle wrapper file.

In Android Studio, I confirmed that I am able to build (Make project) and run the app.

wilywork · 2020-01-21T12:42:23Z

@erisu command "cordova platform add github:breautek/cordova-android\#gradle-5.x" not work for me..

Any solution ?

C:\android_build>cordova platform add github:breautek/cordova-android\#gradle-5.x
Using cordova-fetch for github:breautek/cordova-android\#gradle-5.x
Failed to fetch platform github:breautek/cordova-android\#gradle-5.x
Probably this is either a connection problem, or platform spec is incorrect.
Check your connection and platform name/version/URL.
Error: npm: Command failed with exit code 1 Error output:
npm ERR! Error while executing:
npm ERR! C:\Program Files\Git\cmd\git.EXE ls-remote -h -t ssh://[email protected]/breautek/cordova-android%5C.git
npm ERR!
npm ERR! Host key verification failed.
npm ERR! fatal: Could not read from remote repository.
npm ERR!
npm ERR! Please make sure you have the correct access rights
npm ERR! and the repository exists.
npm ERR!
npm ERR! exited with error code: 128

npm ERR! A complete log of this run can be found in:
npm ERR!     C:\Users\xandy\AppData\Roaming\npm-cache\_logs\2020-01-21T12_36_03_938Z-debug.log```

RafaelKr · 2020-01-21T12:51:10Z

@wilywork Try cordova platform add https://github.com/breautek/cordova-android\#gradle-5.x instead.

erisu · 2020-01-21T12:57:20Z

There might a difference between the Windows and Linux/macOS syntax when passing in the GitHub URL.

For example, I escape the # which is needed. But for Windows maybe that is not required and causes your problem.

Additionally, since this PR had been merged, you can use the Apache repo instead. I would not recommend using his branch as he could delete the branch at any time.

Try what @RafaelKr suggested.

Lastly, please note that we do not consider or suggest using the master branch in production. Master is still an active development branch and would not go through an official release vote.

Testing and reporting is always welcomed.

breautek · 2020-01-21T13:02:53Z

You can only use ssh urls if you have write access to the repo, which in this case he does not.

Additionally, because this PR is merged in, I'll be deleting my gradle-5.x branch, so using the Apache repo will now be required.

Thanks @erisu for picking this up.

RafaelKr · 2020-01-21T13:07:00Z

@breautek No, I also thought the problem comes from using SSH. But @erisu mentioned the escaped # and that's right.

His log says Files\Git\cmd\git.EXE ls-remote -h -t ssh://[email protected]/breautek/cordova-android%5C.git and %5C is the url encoded backslash.
On my Linux system it's working with SSH.

@wilywork try this: cordova platform add github:apache/cordova-android#8ef742e
breautek just deleted his branch, so all the other mentioned methods won't work anymore.

Edit: @erisu pointed out using the master branch is not suggested. To get exactly the current state I included the specific commit id (8ef742e).

breautek force-pushed the gradle-5.x branch from 9db5123 to 9528bb1 Compare July 24, 2019 00:05

breautek marked this pull request as ready for review July 24, 2019 00:06

breautek changed the title ~~Updated gradle from 4.10.3 to 5.5.1~~ Gradle upgrade from 4.10.3 to 5.5.1 Jul 24, 2019

erisu added this to the 9.0.0 milestone Jul 24, 2019

erisu added the enhancement label Jul 24, 2019

brodycj mentioned this pull request Jul 28, 2019

[MAJOR] Update for Gradle version 5 #780

Closed

breautek changed the title ~~Gradle upgrade from 4.10.3 to 5.5.1~~ Gradle upgrade from 4.10.3 to 5.x Sep 8, 2019

piotr-cz reviewed Sep 17, 2019

View reviewed changes

package.json Outdated Show resolved Hide resolved

brodycj changed the title ~~Gradle upgrade from 4.10.3 to 5.x~~ [MAJOR] Gradle upgrade from 4.10.3 to 5.x Sep 23, 2019

timbru31 approved these changes Sep 24, 2019

View reviewed changes

timbru31 requested review from erisu and brodycj September 24, 2019 00:18

erisu approved these changes Sep 24, 2019

View reviewed changes

breautek mentioned this pull request Oct 6, 2019

gradle wrapper broken #754

Closed

3 tasks

breautek mentioned this pull request Nov 14, 2019

Gradle Sync Issues: "NdkCompile is no longer supported" #834

Closed

breautek changed the title ~~[MAJOR] Gradle upgrade from 4.10.3 to 5.x~~ [MAJOR] Gradle upgrade from 4.10.3 to 6.x Nov 15, 2019

timbru31 reviewed Nov 19, 2019

View reviewed changes

bin/templates/project/app/build.gradle Outdated Show resolved Hide resolved

erisu requested changes Jan 18, 2020

View reviewed changes

bin/templates/project/app/build.gradle Outdated Show resolved Hide resolved

bin/templates/project/build.gradle Outdated Show resolved Hide resolved

test/build.gradle Outdated Show resolved Hide resolved

breautek and others added 7 commits January 21, 2020 10:06

(android) Updated gradle to 5.5.1

684760c

added npm clean script

9b30955

upgraded gradle from 5.5.1 to 5.6.2

9480eb4

Replaced clean command from git clean usage to using a gulpfile for m…

ec29b1b

…ore fine control over which files needing to be 'cleaned'

removed gulp and replaced the gulpfile with a simple node script to c…

204401d

…lean test gradle installation

Upgraded gradle to current latest release 6.0

951dee0

Upgraded android gradle plugin to version 3.5.2 (current stable) Removed useDeprecatedNdk as this option is now completely removed from gradle.

feat: bump gradle to 6.1 & gradle build tools to 3.5.3

9595ba9

erisu force-pushed the gradle-5.x branch from 5f4cb04 to 9595ba9 Compare January 21, 2020 01:37

erisu approved these changes Jan 21, 2020

View reviewed changes

erisu merged commit 8ef742e into apache:master Jan 21, 2020

breautek deleted the gradle-5.x branch January 21, 2020 13:03

brodycj mentioned this pull request Jun 5, 2020

[major] feat: Gradle 6.5 & Android Gradle plugin 4.0.0 updates #988

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[MAJOR] Gradle upgrade from 4.10.3 to 6.x #792

[MAJOR] Gradle upgrade from 4.10.3 to 6.x #792

breautek commented Jul 24, 2019 •

edited by erisu

Loading

breautek commented Jul 24, 2019

codecov-io commented Jul 24, 2019 •

edited

Loading

janpio commented Jul 24, 2019

breautek commented Jul 24, 2019 •

edited

Loading

erisu commented Jul 25, 2019 •

edited

Loading

breautek commented Jul 30, 2019 •

edited

Loading

erisu commented Jul 30, 2019 •

edited

Loading

breautek commented Aug 1, 2019

Kevin-Hamilton commented Aug 8, 2019

breautek commented Aug 8, 2019

breautek commented Sep 9, 2019

timbru31 left a comment

breautek commented Sep 24, 2019

brodycj commented Sep 24, 2019

erisu left a comment

breautek commented Sep 24, 2019

erisu commented Sep 24, 2019 •

edited

Loading

breautek commented Nov 14, 2019

piotr-cz commented Nov 14, 2019

breautek commented Nov 14, 2019

erisu left a comment •

edited

Loading

wilywork commented Jan 21, 2020 •

edited

Loading

RafaelKr commented Jan 21, 2020 •

edited

Loading

erisu commented Jan 21, 2020 •

edited

Loading

breautek commented Jan 21, 2020

RafaelKr commented Jan 21, 2020 •

edited

Loading

[MAJOR] Gradle upgrade from 4.10.3 to 6.x #792

[MAJOR] Gradle upgrade from 4.10.3 to 6.x #792

Conversation

breautek commented Jul 24, 2019 • edited by erisu Loading

Platforms affected

Motivation and Context

Description

Testing

Checklist

breautek commented Jul 24, 2019

codecov-io commented Jul 24, 2019 • edited Loading

Codecov Report

janpio commented Jul 24, 2019

breautek commented Jul 24, 2019 • edited Loading

erisu commented Jul 25, 2019 • edited Loading

breautek commented Jul 30, 2019 • edited Loading

erisu commented Jul 30, 2019 • edited Loading

breautek commented Aug 1, 2019

Kevin-Hamilton commented Aug 8, 2019

breautek commented Aug 8, 2019

breautek commented Sep 9, 2019

timbru31 left a comment

Choose a reason for hiding this comment

breautek commented Sep 24, 2019

brodycj commented Sep 24, 2019

erisu left a comment

Choose a reason for hiding this comment

breautek commented Sep 24, 2019

erisu commented Sep 24, 2019 • edited Loading

breautek commented Nov 14, 2019

piotr-cz commented Nov 14, 2019

breautek commented Nov 14, 2019

erisu left a comment • edited Loading

Choose a reason for hiding this comment

wilywork commented Jan 21, 2020 • edited Loading

RafaelKr commented Jan 21, 2020 • edited Loading

erisu commented Jan 21, 2020 • edited Loading

breautek commented Jan 21, 2020

RafaelKr commented Jan 21, 2020 • edited Loading

breautek commented Jul 24, 2019 •

edited by erisu

Loading

codecov-io commented Jul 24, 2019 •

edited

Loading

breautek commented Jul 24, 2019 •

edited

Loading

erisu commented Jul 25, 2019 •

edited

Loading

breautek commented Jul 30, 2019 •

edited

Loading

erisu commented Jul 30, 2019 •

edited

Loading

erisu commented Sep 24, 2019 •

edited

Loading

erisu left a comment •

edited

Loading

wilywork commented Jan 21, 2020 •

edited

Loading

RafaelKr commented Jan 21, 2020 •

edited

Loading

erisu commented Jan 21, 2020 •

edited

Loading

RafaelKr commented Jan 21, 2020 •

edited

Loading