{"id":15677676,"url":"https://github.com/schniz/benchy-action","last_synced_at":"2025-05-07T01:40:56.806Z","repository":{"id":64858239,"uuid":"576000106","full_name":"Schniz/benchy-action","owner":"Schniz","description":"a hassle-free GitHub Action to benchmark your code continuously.","archived":false,"fork":false,"pushed_at":"2023-12-06T10:45:10.000Z","size":1003,"stargazers_count":13,"open_issues_count":6,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-23T22:23:32.345Z","etag":null,"topics":["action","actions","benchmark","github-actions","performance"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Schniz.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-12-08T19:26:16.000Z","updated_at":"2024-03-19T16:08:21.000Z","dependencies_parsed_at":"2024-10-23T13:05:22.872Z","dependency_job_id":null,"html_url":"https://github.com/Schniz/benchy-action","commit_stats":{"total_commits":18,"total_committers":3,"mean_commits":6.0,"dds":"0.16666666666666663","last_synced_commit":"fe38f88d28b4d7962244e1b3d5abb17c94244dac"},"previous_names":[],"tags_count":9,"template":false,"template_full_name":"actions/javascript-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Schniz%2Fbenchy-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Schniz%2Fbenchy-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Schniz%2Fbenchy-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Schniz%2Fbenchy-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Schniz","download_url":"https://codeload.github.com/Schniz/benchy-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252797769,"owners_count":21805763,"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":["action","actions","benchmark","github-actions","performance"],"created_at":"2024-10-03T16:10:15.272Z","updated_at":"2025-05-07T01:40:56.768Z","avatar_url":"https://github.com/Schniz.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# benchy-action\n\nA continuous benchmarking tool for GitHub Actions.\n\n## Installation\n\nYou can [install the GitHub app here](https://github.com/apps/benchy-commenter) to get comments on pull requests and commits\nautomatically.\n\nThis is not mandatory, and you can use this action without the app: instead of getting comments,\nthe action will print an ASCII table in the logs.\n\n## Example usage\n\n```yaml\nname: My CI test\njobs:\n  build:\n    runs-on: ubuntu-latest\n    permissions:\n      contents: read\n      # more on this later\n      id-token: write\n    steps:\n      - uses: actions/checkout@v3\n      - uses: Schniz/benchy-action@v2\n        with:\n          key: \"a value to track\"\n          value: 666\n```\n\n## The `id-token` Permissions\n\nBenchy is built to be hassle-free and to be used as fast as possible: without any authentication or registration.\nSo, in order to authenticate the requests from GitHub Actions we use the [OpenID Connect feature of GitHub Actions](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#overview-of-openid-connect) to get an ID token that is signed by GitHub and contains the information about the repository and the workflow run.\n\nEnabling `id-token: write` on the GitHub Actions job will enable the action to get an ID token and use it to authenticate the requests to the Benchy API.\n\n## Action Inputs\n\n| Name              | Description                                                                                                                                                                    |\n| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `key`             | The key to track                                                                                                                                                               |\n| `value`           | The value to track                                                                                                                                                             |\n| `json`            | Data to track in a JSON format                                                                                                                                                 |\n| `input_file`      | Path to a JSON file to track data from                                                                                                                                         |\n| `track_file_size` | A glob pattern to track the size of files in the repository. For example, `dist/**/*.min.js` will track the size of all the minified JavaScript files in the `dist` directory. |\n\nSee the [JSON Schema](./dist/file-schema.json) for the format of the JSON value/file.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fschniz%2Fbenchy-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fschniz%2Fbenchy-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fschniz%2Fbenchy-action/lists"}