File tree 2 files changed +10
-6
lines changed
2 files changed +10
-6
lines changed Original file line number Diff line number Diff line change 1
- # Autometrics Metrics Report
1
+ # Autometrics Report
2
2
3
- A Github action that comments on PRs to tell you how metrics are going to be affected. The
4
- report tells you immediately if your new feature is well instrumented, and shows a useful
5
- summary of the metrics that will be reported without needing to go through the diff.
3
+ This Github action will comment on Pull Requests to tell you how metrics are
4
+ going to be affected.
6
5
7
- <!-- Put a screen shot of the PR comment here. -->
6
+ The report tells you immediately if your new feature is well instrumented, and
7
+ shows a useful summary of the metrics that will be reported without needing to
8
+ go through the diff.
9
+
10
+ ![ An example of generated report on Github] ( ./assets/comment_preview.png )
8
11
9
12
## Inputs
10
13
11
14
- ` gh-token ` : a github token that gives access to
12
15
+ the PR
13
16
+ the repo
14
17
+ read/write access to comments on issues/PR
18
+
15
19
** The built-in ` ${{ secrets.GITHUB_TOKEN }} ` will work, you do not need to create a new one.**
16
20
To make the built-in token work, the job must be given a specific set of permissions. The permissions added in the
17
21
[ "Example Usage" section] ( #example-usage ) show the minimal set of permissions needed.
@@ -116,7 +120,7 @@ Look at the issues in the repository to see the advancement of language support.
116
120
All languages in the table will be eventually supported.
117
121
118
122
Language | Support
119
- :---:|:---:|:---:
123
+ :---:|:---:
120
124
[Rust](https://github.com/autometrics-dev/autometrics-rs) | ✅
121
125
[Typescript](https://github.com/autometrics-dev/autometrics-ts) | ❌
122
126
[Go](https://github.com/autometrics-dev/autometrics-go) | ❌
You can’t perform that action at this time.
0 commit comments