Gradle<\/a> is commonly used by developers to manage their project’s build lifecycle. It’s the default choice of build tool for all new Android projects.<\/p>\n In this tutorial, we’ll learn about Gradle Wrapper, an accompanying utility that makes it easier to distribute projects.<\/p>\n To build a Gradle-based project, we need to have Gradle installed in our machine. However, if our installed version doesn’t match with the project’s version, we’ll probably face many incompatibility problems.<\/p>\n Gradle Wrapper, also called Wrapper <\/em>in short, solves this problem. It’s a script that runs Gradle tasks with a declared version<\/strong>. If the declared version is not installed, Wrapper installs the required one.<\/p>\n The main benefits of Wrapper are that we can:<\/p>\n In the next sections, we’ll be running Gradle tasks that require Gradle to be installed locally<\/a>.<\/p>\n To use Wrapper, we need to generate some particular files. We’ll generate these files using the built-in Gradle task called wrapper. <\/em><\/strong>Note that we need to generate these files only once.<\/p>\n Now, let’s run the wrapper<\/em> task in our project directory:<\/p>\n Let’s see the output of this command:<\/p>\n Let’s have a look at what these files are:<\/p>\n By default, the wrapper<\/em> task generates Wrapper files with the Gradle version currently installed on the machine. We can specify another version if needed:<\/p>\n We recommended checking the Wrapper files into<\/strong> the source control system<\/strong> like GitHub. This way we ensure that other developers can run the project without the need to install Gradle.<\/p>\n We can run any Gradle task with the Wrapper by replacing gradle<\/em> with <\/strong>gradlew<\/strong>.<\/em><\/p>\n To list the available tasks, we can use the gradlew tasks<\/em> command:<\/p>\n Let’s have a look at the output:<\/p>\n As we can see, the output is the same as we would get when running this task with the gradle<\/em> command.<\/p>\n Now, let’s look at some common issues that we may face when working with Wrapper.<\/p>\n Some organizations do not allow developers to check jar files into their source control system. Typically, such projects have a rule in the global .gitignore<\/em> file to ignore all jar files. Therefore, the gradle-wrapper.jar<\/em> file is not checked into the git repository. For this reason, Wrapper tasks fail to run on other machines. In such cases, we need to add the gradle-wrapper.jar<\/em> file to git forcefully<\/strong>:<\/p>\n Similarly, we may have a project-specific .gitignore<\/em> file that ignores jar files. We can fix it either by relaxing the .gitignore<\/em> rule or by adding the wrapper jar file forcefully, as shown above.<\/p>\n When checking in a Wrapper-based project, we may forget to include the wrapper<\/em> folder that exists inside the gradle<\/em> folder. But as we have seen above, the wrapper<\/em> folder contains two critical files: gradle-wrapper.jar <\/em>and gradle-wrapper.properties.<\/em><\/p>\n Without these files, we’ll get errors when running Gradle tasks with the Wrapper. Therefore, we must check the wrapper<\/em> folder into the source control system<\/strong>.<\/p>\n Gradle-based projects contain a .gradle<\/em> folder that stores cache to speed up Gradle tasks. Sometimes, we need to clear the cache <\/span>in order to troubleshoot Gradle build issues. <\/span>Usually, we remove the entire .gradle<\/em> folder. <\/span>But we may mistake the Wrapper gradle<\/i> folder with the .gradle<\/i> folder and remove it, too. After that, we’ll definitely face problems when trying to run Gradle tasks with the Wrapper.<\/span><\/p>\n We can solve this problem by pulling the latest changes from the source<\/strong>. Alternatively, we can regenerate the Wrapper files.<\/span><\/p>\n In this tutorial, we learned about Gradle Wrapper and its basic usage. We also learned about some common problems we may face when working with Gradle Wrapper.<\/p>\n As usual, we can check the project with generated Gradle Wrapper files over on GitHub<\/a>.<\/p>\n The post Guide to the Gradle Wrapper<\/a> first appeared on Baeldung<\/a>.<\/p>\n In this tutorial, we’ll learn about Gradle Wrapper, an accompanying utility that makes it easier to distribute projects.<\/p>\n The post Guide to the Gradle Wrapper<\/a> first appeared on Baeldung<\/a>.<\/p>\n2. Gradle Wrapper<\/h2>\n
\n
2.1. Generating Wrapper Files<\/h3>\n
$ gradle wrapper\r\n<\/code><\/pre>\n![\"\"](\"https:\/\/www.baeldung.com\/wp-content\/uploads\/2020\/09\/gradle-wrapper.png\")
<\/a><\/p>\n\n
$ gradle wrapper --gradle-version 6.3\r\n<\/code><\/pre>\n2.2. Running Gradle Commands with Wrapper<\/h3>\n
$ gradlew tasks<\/code><\/pre>\nHelp tasks\r\n----------\r\nbuildEnvironment - Displays all buildscript dependencies declared in root project 'gradle-wrapper'.\r\ncomponents - Displays the components produced by root project 'gradle-wrapper'. [incubating]\r\ndependencies - Displays all dependencies declared in root project 'gradle-wrapper'.\r\ndependencyInsight - Displays the insight into a specific dependency in root project 'gradle-wrapper'.\r\ndependentComponents - Displays the dependent components of components in root project 'gradle-wrapper'. [incubating]\r\nhelp - Displays a help message.\r\nmodel - Displays the configuration model of root project 'gradle-wrapper'. [incubating]\r\noutgoingVariants - Displays the outgoing variants of root project 'gradle-wrapper'.\r\nprojects - Displays the sub-projects of root project 'gradle-wrapper'.\r\nproperties - Displays the properties of root project 'gradle-wrapper'.\r\ntasks - Displays the tasks runnable from root project 'gradle-wrapper'.<\/code><\/pre>\n3. Common Issues<\/h2>\n
3.1. Global .gitignore That Ignores All Jar Files<\/strong><\/h3>\n
git add -f gradle\/wrapper\/gradle-wrapper.jar<\/code><\/pre>\n3.2. Missing Wrapper Folder<\/strong><\/h3>\n
3.3. Removed Wrapper Files<\/strong><\/h3>\n
4. Conclusion<\/h2>\n
<\/p>\n
![](\"https:\/\/assets.feedblitz.com\/i\/fblike20.png\")
<\/a> ![](\"https:\/\/assets.feedblitz.com\/i\/googleplus20.png\")
<\/a> ![](\"https:\/\/assets.feedblitz.com\/i\/pinterest20.png\")
<\/a> ![](\"https:\/\/assets.feedblitz.com\/i\/twitter20.png\")
<\/a> ![](\"https:\/\/assets.feedblitz.com\/i\/email20.png\")
<\/a> ![](\"https:\/\/assets.feedblitz.com\/i\/rss20.png\")
<\/a> ![](\"https:\/\/assets.feedblitz.com\/i\/comments20.png\")
<\/a> ![](\"https:\/\/assets.feedblitz.com\/i\/commentsrss20.png\")
<\/a> <\/div>\n\n![\\\"IT\u96fb\u8166\u88dc\u7fd2](\\\"http:\/\/itteacheritfreelance.hk\/test\/wordpress\/wp-content\/uploads\/2016\/05\/logo2-2.png\\\"){kind=logo}
\r\nwww.itsec.hk<\/a>
\r\nwww.itsec.vip<\/a>
\r\nwww.itseceu.uk<\/a>
<\/p>","protected":false},"excerpt":{"rendered":"<\/a> <\/a> <\/a> <\/a> <\/a> <\/a> <\/a> <\/a> <\/div>\n<\/div>","protected":false},"author":214,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"slim_seo":{"title":"Guide to the Gradle Wrapper - ITTeacherITFreelance.hk","description":"In this tutorial, we'll learn about Gradle Wrapper, an accompanying utility that makes it easier to distribute projects. The post Guide to the Gradle Wrapper fi"},"footnotes":""},"categories":[6],"tags":[],"_links":{"self":[{"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/posts\/81736"}],"collection":[{"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/users\/214"}],"replies":[{"embeddable":true,"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/comments?post=81736"}],"version-history":[{"count":8,"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/posts\/81736\/revisions"}],"predecessor-version":[{"id":85417,"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/posts\/81736\/revisions\/85417"}],"wp:attachment":[{"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/media?parent=81736"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/categories?post=81736"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/tags?post=81736"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}