{"id":13608221,"url":"https://github.com/passy/build-time-tracker-plugin","last_synced_at":"2025-05-16T16:09:17.123Z","repository":{"id":19145395,"uuid":"22375669","full_name":"passy/build-time-tracker-plugin","owner":"passy","description":"Gradle plugin to continuously track and report your build times","archived":false,"fork":false,"pushed_at":"2019-05-28T13:34:49.000Z","size":856,"stargazers_count":1214,"open_issues_count":21,"forks_count":67,"subscribers_count":18,"default_branch":"master","last_synced_at":"2025-04-12T15:57:12.110Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://plugins.gradle.org/plugin/net.rdrei.android.buildtimetracker","language":"Groovy","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/passy.png","metadata":{"files":{"readme":"README.markdown","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-07-29T10:04:48.000Z","updated_at":"2025-04-11T08:24:44.000Z","dependencies_parsed_at":"2022-08-08T03:00:09.641Z","dependency_job_id":null,"html_url":"https://github.com/passy/build-time-tracker-plugin","commit_stats":null,"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/passy%2Fbuild-time-tracker-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/passy%2Fbuild-time-tracker-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/passy%2Fbuild-time-tracker-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/passy%2Fbuild-time-tracker-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/passy","download_url":"https://codeload.github.com/passy/build-time-tracker-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254564127,"owners_count":22092122,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T19:01:25.287Z","updated_at":"2025-05-16T16:09:17.081Z","avatar_url":"https://github.com/passy.png","language":"Groovy","readme":"# ![Build Time Tracker](https://cdn.rawgit.com/passy/build-time-tracker-plugin/cc3bd9dcbda61ae7b699e4048c3f425525352d54/assets/logo.svg)\n\n[![Build Status](https://travis-ci.org/passy/build-time-tracker-plugin.svg?branch=master)](https://travis-ci.org/passy/build-time-tracker-plugin)\n![Maven Version](https://img.shields.io/maven-central/v/net.rdrei.android.buildtimetracker/gradle-plugin.svg?maxAge=2592000)\n[![Stories in Ready](https://img.shields.io/waffle/label/passy/build-time-tracker-plugin/ready.svg)](http://waffle.io/passy/build-time-tracker-plugin)\n\nHow much time do you spend each day waiting for Gradle? Now you know!\n\n## Features\n\n* Sortable bar chart summaries\n* CSV output\n* Daily and total summary\n\n## Screenshot\n\n![Screenshot](assets/screenshot.png)\n\n## Usage\n\nApply the plugin in your `build.gradle`. On Gradle \u003e2.1 you can do this\nusing the Plugin DSL Syntax:\n\n```groovy\nplugins {\n  id \"net.rdrei.android.buildtimetracker\" version \"0.11.0\"\n}\n```\n\nOtherwise, use it as `classpath` dependency:\n\n```groovy\nbuildscript {\n  repositories {\n    mavenCentral()\n  }\n\n  dependencies {\n    classpath \"net.rdrei.android.buildtimetracker:gradle-plugin:0.11.+\"\n  }\n}\n\napply plugin: \"build-time-tracker\"\n```\n\nConfigure the plugin:\n\n```groovy\nbuildtimetracker {\n  reporters {\n    csv {\n      output \"build/times.csv\"\n      append true\n      header false\n    }\n\n    summary {\n      ordered false\n      threshold 50\n      barstyle \"unicode\"\n    }\n\n    csvSummary {\n      csv \"build/times.csv\"\n    }\n  }\n}\n```\n\nUsing the `SNAPSHOT` release:\n\n```groovy\nbuildscript {\n  repositories {\n    maven { url \"https://oss.sonatype.org/content/repositories/snapshots/\" }\n  }\n\n  dependencies {\n    classpath \"net.rdrei.android.buildtimetracker:gradle-plugin:0.12.0-SNAPSHOT\"\n  }\n}\n\n```\n\n## Difference to `--profile`\n\nYou may wonder why you would want to use this plugin when gradle has\na built-in [build\nprofiler](https://docs.gradle.org/current/userguide/tutorial_gradle_command_line.html#sec:profiling_build).\nThe quick version is, that if you just want to quickly check what it is that's\nslowing down your build, `--profile` will be all you need. However, if you want\nto continuously monitor your build and find bottlenecks that develop over time,\nthis plugin may be the right fit for you.  `build-time-tracker` writes a\ncontinuous log that is monoidal and can be collected from various different\nmachines to run statistical analyses. Importantly, the written files contain\nidentifying information about the machine the build happened on so you can\ncompare apples with apples.\n\n## Reporters\n\n### CSVReporter\n\nThe `csv` reporter takes the following options:\n\n* `output`: CSV output file location relative to Gradle execution.\n* `append`: When set to `true` the CSV output file is not truncated. This is\n  useful for collecting a series of build time profiles in a single CSV.\n* `header`: When set to `false` the CSV output does not include a prepended\n  header row with column names. Is desirable in conjunction with `append`.\n\nA basic [R Markdown](http://rmarkdown.rstudio.com/) script, `report.Rmd` is\nincluded for ploting and analysing build times using CSV output.\n\n### CSVSummaryReporter\n\nThe `csvSummary` displays the accumulated total build time from a CSV file.\nThe reporter takes the following option:\n\n* `csv`: Path (relative to the gradle file or absolute) to a CSV file created\n  with the above reporter and the options `append = true` and `header = false`.\n\n### SummaryReporter\n\nThe `summary` reporter gives you an overview of your tasks at the end of the\nbuild. It has the following options:\n\n* `threshold`: (default: 50) Minimum time in milliseconds to display a task.\n* `ordered`: (default: false) Whether or not to sort the output in ascending\n  order by time spent.\n* `barstyle`: (default: \"unicode\") Supports \"unicode\", \"ascii\" and \"none\" for\n  displaying a bar chart of the relative times spent on each task.\n* `successOutput`: (default: \"true\") Redisplay build success or failure message\n  so you don't miss it if the summary output is long.\n* `shortenTaskNames`: (default: \"true\") Shortens long tasks names.\n\n_Note_ This plugin only measures the task times that constitute a build.\nSpecifically, it does not measure the time in configuration at the start\nof a Gradle run. This means that the time to execute a build with very fast\ntasks is not accurately represented in output because it is dominated by\nthe time in configuration instead.\n\n## Developing\n\nThis project is built and tested by [Travis](https://travis-ci.org) at\n[passy/build-time-tracker-plugin](https://travis-ci.org/passy/build-time-tracker-plugin).\n\n## Acknowledgements\n\nThanks to [Sindre Sorhus](https://github.com/sindresorhus) for contributing the\nwonderful logo!\n\n## License\n\n    Copyright 2014 Pascal Hartig\n\n    Licensed under the Apache License, Version 2.0 (the \"License\");\n    you may not use this file except in compliance with the License.\n    You may obtain a copy of the License at\n\n       http://www.apache.org/licenses/LICENSE-2.0\n\n    Unless required by applicable law or agreed to in writing, software\n    distributed under the License is distributed on an \"AS IS\" BASIS,\n    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n    See the License for the specific language governing permissions and\n    limitations under the License.\n","funding_links":[],"categories":["Groovy","Plugins"],"sub_categories":["Building"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpassy%2Fbuild-time-tracker-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpassy%2Fbuild-time-tracker-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpassy%2Fbuild-time-tracker-plugin/lists"}