{"id":19982356,"url":"https://github.com/netlify/delta-action","last_synced_at":"2025-05-04T05:32:19.346Z","repository":{"id":36989354,"uuid":"355480381","full_name":"netlify/delta-action","owner":"netlify","description":"A GitHub Action for capturing benchmark data and tracking its variation against a baseline","archived":false,"fork":false,"pushed_at":"2024-11-18T03:12:29.000Z","size":2870,"stargazers_count":18,"open_issues_count":16,"forks_count":3,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-14T22:37:33.639Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/netlify.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-04-07T09:07:08.000Z","updated_at":"2025-04-04T02:24:45.000Z","dependencies_parsed_at":"2024-01-01T02:37:34.509Z","dependency_job_id":"6f3b64c0-6a88-48d5-a7e4-b0cb4d27afbb","html_url":"https://github.com/netlify/delta-action","commit_stats":{"total_commits":370,"total_committers":13,"mean_commits":28.46153846153846,"dds":"0.19999999999999996","last_synced_commit":"4bb88f7ffa9cf7f3c5c6e3271c3659431427806c"},"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netlify%2Fdelta-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netlify%2Fdelta-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netlify%2Fdelta-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netlify%2Fdelta-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/netlify","download_url":"https://codeload.github.com/netlify/delta-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250887482,"owners_count":21503031,"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-11-13T04:10:56.348Z","updated_at":"2025-05-04T05:32:18.475Z","avatar_url":"https://github.com/netlify.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Delta Action\n\nA GitHub Action for reporting benchmark data and comparing it against a baseline.\n\n\u003cimg width=\"750\" alt=\"Screenshot of a benchmark report comment\" src=\"https://user-images.githubusercontent.com/4162329/115129623-8acac500-9fdf-11eb-9bfc-822a415cb436.png\"\u003e\n\n## The basics\n\nThis action reads benchmark metrics on GitHub pull requests and commits, and reports them by adding a comment with any\nmetrics found. It also compares then against the latest commit on the main branch, treating it as the baseline.\n\nThe action looks for benchmark data in files on the repository root. These should be named in the format\n`.delta.\u003cmetric name\u003e` — e.g. `.delta.install_time` will create a metric called `install_time`.\n\nThese files should contain:\n\n- A number representing the value of the metric\n- The units of the metric (optional)\n- A human-friendly name of the metric (optional)\n\n_Example: `.delta.install_time`_\n\n```\n350ms (Installation time)\n```\n\nThe units will determine how the values will be formatted in the benchmark reports. Supported units are:\n\n- Time (formatted with [`pretty-ms`](https://www.npmjs.com/package/pretty-ms))\n  - `ms` / `milliseconds`\n  - `s` / `seconds`\n- Storage (formatted with [`pretty-bytes`](https://www.npmjs.com/package/pretty-bytes))\n  - `b` / `bytes`\n  - `kb` / `kilobytes`\n- Unitless (formatted with\n  [`Number.prototype.toLocaleString`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toLocaleString))\n\n## Configuration\n\nThe action supports the following optional inputs:\n\n| Name          | Description                                                               | Default       |\n| ------------- | ------------------------------------------------------------------------- | ------------- |\n| `base_branch` | Name of the base branch, if not auto detected                             | autodetect    |\n| `title`       | Title/heading to include in the comments                                  | Delta results |\n| `token`       | GitHub access token                                                       | GITHUB_TOKEN  |\n| `pr_number`   | The PR this run is associated with (for `workflow_run`)                   | autodetect    |\n| `style`       | The rendering style to use when commenting on PRs (options: text, graph)  | graph         |\n\n## Usage\n\n1. Add a benchmark step to your workflow that creates a `.delta.\u003cmetric\u003e` file with the format described above\n\n```yaml\n- name: Run benchmark\n  run: echo 123ms \u003e .delta.install_time\n```\n\n2. Add the action to the workflow\n\n   ```yaml\n   - name: Delta\n     uses: netlify/delta-action@v3\n     with:\n       token: ${{ secrets.GITHUB_TOKEN }}\n   ```\n\n## Contributors\n\nPlease see [CONTRIBUTING.md](./CONTRIBUTING.md) for instructions on how to set up and work on this repository. Thanks\nfor contributing!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetlify%2Fdelta-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnetlify%2Fdelta-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetlify%2Fdelta-action/lists"}