{"id":26221764,"url":"https://github.com/push-based/user-flow-gh-action","last_synced_at":"2025-09-16T15:06:35.912Z","repository":{"id":65161359,"uuid":"561120421","full_name":"push-based/user-flow-gh-action","owner":"push-based","description":"📦 GH action for push-based/user-flow","archived":false,"fork":false,"pushed_at":"2023-10-06T14:51:22.000Z","size":18175,"stargazers_count":4,"open_issues_count":12,"forks_count":4,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-11T17:49:05.410Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/push-based.png","metadata":{"files":{"readme":"README.md","changelog":null,"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-11-03T01:46:53.000Z","updated_at":"2023-10-02T15:31:14.000Z","dependencies_parsed_at":"2025-03-12T16:34:39.949Z","dependency_job_id":"9f54c6b1-d600-4651-81b9-0c3405aa02e9","html_url":"https://github.com/push-based/user-flow-gh-action","commit_stats":{"total_commits":397,"total_committers":5,"mean_commits":79.4,"dds":"0.33249370277078083","last_synced_commit":"8c4e80ff127712c79f4d2522ffc427598d933cab"},"previous_names":[],"tags_count":38,"template":false,"template_full_name":"actions/typescript-action","purl":"pkg:github/push-based/user-flow-gh-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/push-based%2Fuser-flow-gh-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/push-based%2Fuser-flow-gh-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/push-based%2Fuser-flow-gh-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/push-based%2Fuser-flow-gh-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/push-based","download_url":"https://codeload.github.com/push-based/user-flow-gh-action/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/push-based%2Fuser-flow-gh-action/sbom","scorecard":{"id":750234,"data":{"date":"2025-08-11","repo":{"name":"github.com/push-based/user-flow-gh-action","commit":"a9d42660b6bbed3a4b116a74155f7a5d95ca33b5"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.2,"checks":[{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":0,"reason":"Found 0/4 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/ci.yml:1","Warn: no topLevel permission defined: .github/workflows/release.yml:1","Warn: no topLevel permission defined: .github/workflows/user-flow_ci.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/push-based/user-flow-gh-action/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/push-based/user-flow-gh-action/ci.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/push-based/user-flow-gh-action/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/push-based/user-flow-gh-action/release.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/push-based/user-flow-gh-action/release.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/user-flow_ci.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/push-based/user-flow-gh-action/user-flow_ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/user-flow_ci.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/push-based/user-flow-gh-action/user-flow_ci.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/user-flow_ci.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/push-based/user-flow-gh-action/user-flow_ci.yml/main?enable=pin","Warn: npmCommand not pinned by hash: .github/workflows/ci.yml:19","Warn: npmCommand not pinned by hash: .github/workflows/release.yml:32","Warn: npmCommand not pinned by hash: .github/workflows/user-flow_ci.yml:19","Info:   0 out of   6 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   2 third-party GitHubAction dependencies pinned","Info:   0 out of   3 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":0,"reason":"license file not detected","details":["Warn: project does not have a license file"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 28 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"41 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-wf5p-g6vw-rhxx","Warn: Project is vulnerable to: GHSA-jr5f-v2jv-69x6","Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-ghr5-ch3p-vcr6","Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc","Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx","Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc","Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27","Warn: Project is vulnerable to: GHSA-4www-5p9h-95mh","Warn: Project is vulnerable to: GHSA-9gqv-wp59-fq42","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55","Warn: Project is vulnerable to: GHSA-76c9-3jph-rj3q","Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j","Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w","Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg","Warn: Project is vulnerable to: GHSA-76p7-773f-r4q5","Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p","Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36","Warn: Project is vulnerable to: GHSA-pq67-2wwv-3xjx","Warn: Project is vulnerable to: GHSA-8cj5-5rvv-wf4v","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-hc6q-2mpp-qw7j","Warn: Project is vulnerable to: GHSA-4vvj-4cpr-p986","Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6","Warn: Project is vulnerable to: GHSA-4v9v-hfq4-rm2v","Warn: Project is vulnerable to: GHSA-9jgg-88mc-972h","Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7","Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-22T20:06:51.007Z","repository_id":65161359,"created_at":"2025-08-22T20:06:51.007Z","updated_at":"2025-08-22T20:06:51.007Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":275439515,"owners_count":25465041,"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","status":"online","status_checked_at":"2025-09-16T02:00:10.229Z","response_time":65,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":"2025-03-12T16:29:28.546Z","updated_at":"2025-09-16T15:06:35.891Z","avatar_url":"https://github.com/push-based.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Chrome Lighthouse user flows as GitHub action\n\nThis repository maintains a GitHub action to run [@push-based/user-flow](https://github.com/push-based/user-flow) in a workflow.\nIt automatically detects flows, executes them and produces md reports as comments in your PR.\n\n![user-flow-gh-action-cover](https://user-images.githubusercontent.com/10064416/216605948-b8fffdda-3459-48c9-975a-75ec95544d30.png)\n\n**Inputs:**  \n| Name                         |  Type     | Default                     |  Description                                                                                               |  \n|------------------------------| --------- | --------------------------- |----------------------------------------------------------------------------------------------------------- |  \n| **`--commentId`**            | `string`  | `user flow summary report`  | Id used to identify a comment in the PR (useful if multiple actions run user-flow for the same PR)  |  \n| **`--commentsOnly`**         | `string`  | `off`                       | Only collects results and creates a comment in the PR (helpful if the reports are generated over external logic)                    |  \n| **`--rcPath`**               | `string`  | `./user-flowrc.json`        | Path to `.user-flowrc.json`. e.g. `./user-flowrc.server.json`                                                   |  \n| **`--verbose`**              | `string`  | `off`                       | Run with verbose logging (only 'on' and 'off' is possible)                                                 |  \n| **`--dryRun`**               | `string`  | `off`                       | Run in `dryRun` mode (only 'on' and 'off' is possible)                                                     |  \n| **`...`**                    |  ...      | ...                         | All other actions from the user-flow CLI are available                                                     |  \n\n# Setup\n\n1. Create a file called `user-flow-ci.yml` in `./.github/workflows`.\n\nThis can be done by using the `init`:  \n`npx @push-based/user-flow init --generateGhWorkflow`  \n\n2. The generated `user-flow-ci.yml` file should have the following content:\n\n```yml\nname: user-flow-ci\non:\n  pull_request:\njobs:\n  user-flow-integrated-in-ci:\n    runs-on: ubuntu-latest\n    strategy:\n      matrix:\n        node-version: [18.x]\n    steps:\n      - uses: actions/checkout@v2\n      - name: Executing user-flow CLI\n        # without any parameters the rcPath defaults to `.user-flowrc.json`\n        uses: push-based/user-flow-gh-action@v0.1.0\n```\n\nYou can use action inputs over the with property:\n\n```yml\nname: user-flow-ci\non:\n  pull_request:\njobs:\n  user-flow-integrated-in-ci:\n    runs-on: ubuntu-latest\n    strategy:\n      matrix:\n        node-version: [18.x]\n    steps:\n      - uses: actions/checkout@v2\n      - name: Executing user-flow CLI\n        # without any parameters the rcPath defaults to `.user-flowrc.json`\n        uses: push-based/user-flow-gh-action@v0.1.0\n        with:\n          commentId: test-e2e-first-run\n          dryRun: off\n          verbose: on\n          url: https://google.com\n          ufPath: ./user-flows\n          outPath: ./packages/user-flow-gh-action-e2e/measures\n          format: html,json\n          rcPath: ./.user-flowrc.json\n```\n\n\n# How to test the setup\n\n1. If you open a new PR in your repository you should see the runner execution your user-flow in the CI\n\n\u003cimg width=\"672\" alt=\"gh-ci-running\" title=\"Action is executing\" src=\"https://user-images.githubusercontent.com/10064416/216594684-ea9e3a5e-007e-47d6-b438-c16d2158f940.PNG\"\u003e\n\u003cimg width=\"583\" alt=\"gh-ci-complete\" title=\"Action completed\" src=\"https://user-images.githubusercontent.com/10064416/216594803-65cb2cfd-1924-44ae-84ec-8b1d09e49ada.PNG\"\u003e\n\n2. After the user flow executed you should see a mark down report as comment attached to your PR\n\n\u003cimg width=\"676\" alt=\"gh-ci-comment\" title=\"Action created comment in PR\" src=\"https://user-images.githubusercontent.com/10064416/216596391-35a041e2-9839-4cf5-b8c5-b55e93cb622e.PNG\"\u003e\n\n\n# How to use it with the nx-plugin and --affected\n\nIf you use Nx as you tooling choice you should consider our [Nx plugin](https://github.com/push-based/user-flow/tree/main/packages/nx-plugin) for [user-flow](https://github.com/push-based/user-flow).\n\nHere is how you can combine it with the GitHub action:\n\n1. Use the action with commentsOnly. besides the outPath no other params are considered.\n```yml\n  name: user-flow-ci\n  on:\n    pull_request:\n  jobs:\n    user-flow-integrated-in-ci:\n      runs-on: ubuntu-latest\n      strategy:\n        matrix:\n          node-version: [18.x]\n      steps:\n        - uses: actions/checkout@v2\n        - name: Executing user-flow CLI\n          uses: push-based/user-flow-gh-action@v0.1.0\n          with:\n            verbose: on\n            commentId: test-e2e-first-run\n            commentsOnly: on\n```\n\n---\n\nmade with ❤ by [push-based.io](https://www.push-based.io)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpush-based%2Fuser-flow-gh-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpush-based%2Fuser-flow-gh-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpush-based%2Fuser-flow-gh-action/lists"}