{"id":13474754,"url":"https://github.com/JCofman/webPagetestAction","last_synced_at":"2025-03-26T22:31:13.240Z","repository":{"id":34232707,"uuid":"171168231","full_name":"JCofman/webPagetestAction","owner":"JCofman","description":"⚡️🚀 Action to print webPagetest.org results ","archived":false,"fork":false,"pushed_at":"2023-02-28T09:16:58.000Z","size":1592,"stargazers_count":58,"open_issues_count":7,"forks_count":7,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-12T11:17:38.558Z","etag":null,"topics":["actions","performance","performance-analysis","webpagetest"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/webpagetest-action","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/JCofman.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2019-02-17T20:24:16.000Z","updated_at":"2025-03-01T23:08:00.000Z","dependencies_parsed_at":"2024-04-17T20:02:25.807Z","dependency_job_id":null,"html_url":"https://github.com/JCofman/webPagetestAction","commit_stats":{"total_commits":66,"total_committers":7,"mean_commits":9.428571428571429,"dds":0.2272727272727273,"last_synced_commit":"de59b3f23ba0386e07300789bf641b2fc870acf9"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JCofman%2FwebPagetestAction","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JCofman%2FwebPagetestAction/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JCofman%2FwebPagetestAction/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JCofman%2FwebPagetestAction/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JCofman","download_url":"https://codeload.github.com/JCofman/webPagetestAction/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245747629,"owners_count":20665826,"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":["actions","performance","performance-analysis","webpagetest"],"created_at":"2024-07-31T16:01:14.572Z","updated_at":"2025-03-26T22:31:12.433Z","avatar_url":"https://github.com/JCofman.png","language":"JavaScript","funding_links":[],"categories":["Community Resources"],"sub_categories":["Frontend Tools"],"readme":"# ⚠️ Deprecated!\n\nSince webpagetest has a paid business model now you may want to checkout their official github action. You can still use this action if you have a valid WebPageTest API key or set up your own [WebPageTest instance](https://docs.webpagetest.org/private-instances/)\n\n- [Webpagetest official action](https://github.com/marketplace/actions/webpagetest-github-action)\n\n## WebPageTest GitHub Action\n[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors)\n\n⚡️🚀 GitHub Action to print [webPageTest.org](https://www.webpagetest.org/) results as a commit comment after a push.\n\n\u003cp\u003e\u003c/p\u003e\n\u003cdetails\u003e\n  \u003csummary\u003e Click to see example commit comment \u003c/summary\u003e\n\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"example image\" src=\"https://github.com/JCofman/webPagetestAction/blob/master/example.png\"/\u003e\n\u003c/p\u003e\n\u003c/details\u003e\n\u003cp\u003e\u003c/p\u003e\n\nMake sure to pass a WEBPAGETEST_API_KEY which you can get [here](https://www.webpagetest.org/getkey.php) and a TEST_URL.\n\n## Secrets\n\n- GITHUB_TOKEN - Required GitHub token provided by actions to validate requests and make sure you are allowed to comment on the repo\n- WEBPAGETEST_API_KEY - Required API key which you either can provide by your own hosted WebPageTest instance or can get here [here](https://www.webpagetest.org/getkey.php)\n\n## Environment Variables\n\n- WEBPAGETEST_SERVER_URL - Optional By default this repo uses the awesome free WebPageTest `www.webpagetest.org` server offered by Akami but you can provide your own hosted version.\n- TEST_URL - URL to run the audit e.g. `https://jcofman.de`\n\n## Args\n\nYou should be able to provide custom args as mentioned in the [marcelduran/webpagetest-api](https://github.com/marcelduran/webpagetest-api#test-works-for-test-command-only) under the `Test (works for test command only)` section.\n\n## Examples\n\n```yml\non: push\nname: Run Webpagetest\njobs:\n  webPageTestActions:\n    name: WebPageTestActions\n    runs-on: ubuntu-latest\n    steps:\n      - uses: JCofman/webPagetestAction@master\n        env:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n          TEST_URL: https://example.com\n          WEBPAGETEST_API_KEY: ${{ secrets.WEBPAGETEST_API_KEY }}\n```\n\nWith self hosted WebPagetest server\n\n```yml\non: push\nname: Run Webpagetest\njobs:\n  webPageTestActions:\n    name: WebPageTestActions\n    runs-on: ubuntu-latest\n    steps:\n      - uses: JCofman/webPagetestAction@master\n        env:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n          TEST_URL: https://example.com\n          WEBPAGETEST_API_KEY: ${{ secrets.WEBPAGETEST_API_KEY }}\n          WEBPAGETEST_SERVER_URL: www.your-custom-server.org\n```\n\n\nWhen you use the default action without any custom arguments some defaults will be set:\n\n```js\n        location: \"Dulles_MotoG4\", // \u003clocation\u003e string to test from https://www.webpagetest.org/getLocations.php?f=html\n        connectivity:  \"3GSlow\", // \u003cprofile\u003e string: connectivity profile -- requires location to be specified -- (Cable|DSL|3GSlow|3G|3GFast|4G|LTE|Edge|2G|Dial|FIOS|Native|custom) [Cable]\n        runs: 3, // \u003cnumber\u003e: number of test runs [1]\n        first: false, // skip the Repeat View test\n        video: true, // capture video\n        pollResults: 5, // \u003cnumber\u003e: poll results\n        private: true, // keep the test hidden from the test log\n        label: \"Github Action\", // \u003clabel\u003e: string label for the test\n        mobile: 1,\n        device: \"Motorola G (gen 4)\",\n        timeout: 10000,\n        lighthouse: true,\n```\n\nYou can provide your own custom args like the `location` and `connectivity` ⚠️ keep in mind that some devices locations and arguments don't work together ⚠️. You can find more details [here](https://github.com/marcelduran/webpagetest-api#test-works-for-test-command-only)\n\n```yml\non: push\nname: Run Webpagetest\njobs:\n  webPageTestActions:\n    name: WebPageTestActions\n    runs-on: ubuntu-latest\n    steps:\n      - uses: JCofman/webPagetestAction@master\n        env:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n          TEST_URL: https://example.com\n          WEBPAGETEST_API_KEY: ${{ secrets.WEBPAGETEST_API_KEY }}\n          WEBPAGETEST_SERVER_URL: www.your-custom-server.org\n         with:\n          args: location=\"Dulles_Nexus5\" connectivity=\"DSL\"\n```\n\n## Contributors ✨\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://twitter.com/markusstaab\"\u003e\u003cimg src=\"https://avatars2.githubusercontent.com/u/120441?v=4\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eMarkus Staab\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/JCofman/webPagetestAction/commits?author=staabm\" title=\"Documentation\"\u003e📖\u003c/a\u003e \u003ca href=\"#ideas-staabm\" title=\"Ideas, Planning, \u0026 Feedback\"\u003e🤔\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://jcofman.de\"\u003e\u003cimg src=\"https://avatars2.githubusercontent.com/u/2118956?v=4\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eJacob Cofman\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/JCofman/webPagetestAction/commits?author=JCofman\" title=\"Documentation\"\u003e📖\u003c/a\u003e \u003ca href=\"https://github.com/JCofman/webPagetestAction/commits?author=JCofman\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"#example-JCofman\" title=\"Examples\"\u003e💡\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/boyum\"\u003e\u003cimg src=\"https://avatars2.githubusercontent.com/u/9085189?v=4\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eSindre Bøyum\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/JCofman/webPagetestAction/commits?author=boyum\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-enable --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FJCofman%2FwebPagetestAction","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FJCofman%2FwebPagetestAction","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FJCofman%2FwebPagetestAction/lists"}