prepare 0.0.1

Author: Vacxe

Diff for: .github/ISSUE_TEMPLATE/bug_report.md

@@ -1,33 +1,16 @@
-name: Publish
+name: Publish new release
 on:
-  workflow_dispatch:
-    inputs:
-      ci:
-        description: "CI pipeline name"
-        required: false
-        default: "ci.yml"
-
+  release:
+    types: [published]
 jobs:
-  Publish:
+  publish:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
 
       - name: Inject slug/short variables
         uses: rlespinasse/github-slug-action@v4
 
-      - name: Check CI status
-        run: |
-          output=$(curl -sSL -X GET -G -H "Accept: application/vnd.github.v3+json" -d "branch=${{ env.GITHUB_REF_SLUG }}" -d "event=push" https://api.github.com/repos/${{ github.repository }}/actions/workflows/${{ github.event.inputs.ci }}/runs | jq -r '.workflow_runs[0] | "\(.conclusion)"')
-          echo "::set-output name=status::$output"
-        id: check
-
-      - name: Abort if CI not successful
-        if: steps.check.outputs.status != 'success'
-        run: |
-          echo ${{ steps.check.outputs.status }}
-          exit 1
-
       - name: Set up JDK
         uses: actions/setup-java@v3
         with:

Diff for: .github/ISSUE_TEMPLATE/feature_request.md

@@ -1 +1,85 @@
-# Build time traker
+# build-time-tracker
+
+Gradle plugin that prints the time taken by the tasks in a build.
+
+Console output example:
+```
+Build finished: 0.643s
+
+:first | 0.229s | 35.61%
+:second | 0.412s | 64.07%
+```
+
+You can customize the plugin as follows:
+
+## Reporters
+### `ConsoleConfiguration`
+
+Parameters:
+* `minDuration: Duration` - `optional` minimum task duration for report, default `0` *(all tasks included)*
+
+`build.gradle.kts`: 
+```
+buildTimeTracker {
+    consoleConfiguration.set(ConsoleConfiguration(Duration.ofMillis(200))
+}
+```
+
+Console output:
+```
+Build finished: 0.643s
+
+:first | 0.229s | 35.61%
+:second | 0.412s | 64.07%
+```
+
+### `CSVConfiguration`
+
+Parameters:
+* `reportFile: String` - `required` path for report file
+* `minDuration: Duration` - `optional` minimum task duration for report, default `0` *(all tasks included)*
+* `includeSystemUserName: Boolean` - `optional` add username to report, default `false`
+* `includeSystemOSName: Boolean` - `optional` add os name to report, default `false`
+
+`build.gradle.kts`:
+```
+buildTimeTracker {
+    csvConfiguration.set(CSVConfiguration("${project.buildDir}/report/buildStats.csv", Duration.ofMillis(200), true, true)) 
+}
+```
+
+`buildStats.csv` output:
+```
+:first, 229, 2023-06-12T04:59:05.621Z, 2023-06-12T04:59:05.850Z, myusername, Windows 11
+:second, 411, 2023-06-12T04:59:05.852Z, 2023-06-12T04:59:06.263Z, myusername, Windows 11
+```
+
+### `MarkdownConfiguration`
+
+Parameters:
+* `reportFile: String` - `required` path for report file
+* `minDuration: Duration` - `optional` minimum task duration for report, default `0` *(all tasks included)*
+* `withTableLabels: Boolean` - `optional` add table labels, default `true`
+
+`build.gradle.kts`:
+```
+buildTimeTracker {
+    markdownConfiguration.set(MarkdownConfiguration("${project.buildDir}/report/buildStats.md", Duration.ofMillis(0))) 
+}
+```
+
+`buildStats.md` output:
+```
+#### Build finished: 0.638s
+|Task|Duration|Proportion|
+|---|---|---|
+|:first|0.223s|34.95%|
+|:second|0.413s|64.73%|
+```
+
+## Minimum Requirements
+- Java 11
+- Gradle 6.1
+
+## License
+Copyright 2022 Abhijit Sarkar - Released under [Apache License v2.0](LICENSE).

Diff for: .github/workflows/ci.yml

@@ -6,7 +6,7 @@ pluginVcsUrl = https://github.com/vacxe/build-time-tracker.git
 pluginTags = performance, build, metrics
 pluginId = io.github.vacxe.build-time-tracker
 pluginDisplayName = build-time-tracker
-pluginDescription = Gradle plugin that prints the time taken by the tasks in a build
+pluginDescription = Gradle plugin that reporting build statistic for each task
 pluginImplementationClass = io.github.vacxe.buildtimetracker.BuildTimeTrackerPlugin
 pluginDeclarationName = buildTimeTrackerPlugin