{"id":28366982,"url":"https://github.com/infuseai/piperider-compare-action","last_synced_at":"2025-10-05T23:03:46.929Z","repository":{"id":143616086,"uuid":"616369330","full_name":"InfuseAI/piperider-compare-action","owner":"InfuseAI","description":null,"archived":false,"fork":false,"pushed_at":"2023-11-30T17:50:14.000Z","size":128,"stargazers_count":9,"open_issues_count":1,"forks_count":5,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-09-14T07:28:11.045Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","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/InfuseAI.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":"CODEOWNERS","security":null,"support":null,"governance":null}},"created_at":"2023-03-20T08:56:37.000Z","updated_at":"2024-02-16T04:19:16.000Z","dependencies_parsed_at":"2023-03-31T13:06:43.861Z","dependency_job_id":"42aa767f-cc40-4989-b19b-d789961f64da","html_url":"https://github.com/InfuseAI/piperider-compare-action","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/InfuseAI/piperider-compare-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/InfuseAI%2Fpiperider-compare-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/InfuseAI%2Fpiperider-compare-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/InfuseAI%2Fpiperider-compare-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/InfuseAI%2Fpiperider-compare-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/InfuseAI","download_url":"https://codeload.github.com/InfuseAI/piperider-compare-action/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/InfuseAI%2Fpiperider-compare-action/sbom","scorecard":{"id":66440,"data":{"date":"2025-08-11","repo":{"name":"github.com/InfuseAI/piperider-compare-action","commit":"760faa3e635dc220a79f733581e422e815c0f81d"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"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":"Code-Review","score":2,"reason":"Found 4/14 approved changesets -- score normalized to 2","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":"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":"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":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"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":"Dangerous-Workflow","score":-1,"reason":"no workflows found","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":"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":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"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":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: containerImage not pinned by hash: compare-action/Dockerfile:1: pin your Docker image by updating piperider/piperider:latest to piperider/piperider:latest@sha256:53e2130a6353f64692d397224a7f3313a32d70011345a2398b6986f29b44823d","Warn: pipCommand not pinned by hash: compare-action/entrypoint.sh:14","Warn: pipCommand not pinned by hash: compare-action/entrypoint.sh:31","Warn: pipCommand not pinned by hash: compare-action/entrypoint.sh:41","Warn: pipCommand not pinned by hash: compare-action/entrypoint.sh:49","Info:   0 out of   4 pipCommand dependencies pinned","Info:   0 out of   1 containerImage 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":"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 27 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"}}]},"last_synced_at":"2025-08-15T02:41:37.248Z","repository_id":143616086,"created_at":"2025-08-15T02:41:37.248Z","updated_at":"2025-08-15T02:41:37.248Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278532349,"owners_count":26002346,"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-10-05T02:00:06.059Z","response_time":54,"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-05-29T00:13:48.230Z","updated_at":"2025-10-05T23:03:46.918Z","avatar_url":"https://github.com/InfuseAI.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\u003ca href=\"https://github.com/InfuseAI/piperider\" target=\"_blank\"\u003e\u003cimg src=\"https://i.imgur.com/oWUjZT6.png\" alt=\"PipeRider Comparison on Github Pull Request via Github Action\" height=\"36px\" /\u003e\u003c/a\u003e\u003c/p\u003e\n\n# **PipeRider Compare Action 🚀**\n\nThe PipeRider Compare Action is a GitHub Action built on [PipeRider](https://github.com/InfuseAI/piperider). It allows you to run the PipeRider Compare tool directly from your GitHub repository so you can merge Pull Requests with confidence.\n\n## **Description 🔍**\n\nThis action runs the PipeRider Compare tool and enables you to compare different versions of your DATA 📊. You can use this action to test the quality of your DATA and identify any kinds of issues. So whether you're a developer 🧑‍💻, a data engineer 🧑‍🔧, or a data scientist 🧑‍🔬, the PipeRider Compare Action can help you ensure that your data is top-notch!\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://i.imgur.com/ztaXF4F.png\" alt=\"PipeRider Comparison on Github Pull Request via Github Action\" width=\"400px\" /\u003e\n\u003c/p\u003e\n\n## **Usage**\n\n### Basic Usage\n\nIn order to use the PipeRider Compare Action, you must have a PipeRider project, and create a workflow file in your GitHub repository that specifies this action as one of the steps. It is important to note that this action is only triggered by the pull_request event.\n\nWhen defining your workflow, you may need to add permissions to the `pull-requests` field in order to enable the action to write to pull requests. You can do this by adding the permissions field as shown below:\n\nTo use the PipeRider Compare Action, you can follow the example below:\n\n```yaml\nname: PR with PipeRider\n\non: [pull_request]\n\njobs:\n  piperider-compare:\n    runs-on: ubuntu-latest\n    permissions:\n      contents: read\n      pull-requests: write\n    steps:\n    - uses: actions/checkout@v3\n\n    - name: PipeRider Compare\n      uses: InfuseAI/piperider-compare-action@v1\n```\n\n### DBT Integration\nIf you are using dbt to manage your data transformation and want to leverage PipeRider to automate data reliability testing, you need to configure your dbt project and GitHub repository settings properly.  We show you how to do this with snowflake as an example.\n\nFirst, to install a specific adapter, you need a requirements.txt file that lists the dependencies for your project.\n\n```text\npiperider[snowflake]\ndbt-snowflake\n```\n\nSecond, you need to put your dbt profiles.yml file under your dbt project root directory in your GitHub repository. This file contains the connection information for your data warehouse and the target schema for your dbt models. PipeRider will use this file to connect to your data source and profile your models.\n\n```yaml\njaffle_shop:\n  target: dev\n  outputs:\n    dev:\n      type: snowflake\n      account: \"{{ env_var('SNOWFLAKE_ACCOUNT') | as_text }}\"\n\n      # User/password auth\n      user: \"{{ env_var('SNOWFLAKE_USER') | as_text }}\"\n      password: \"{{ env_var('SNOWFLAKE_PASSWORD') | as_text }}\"\n\n      role: \"{{ env_var('SNOWFLAKE_ROLE') | as_text }}\"\n      database: \"{{ env_var('SNOWFLAKE_DATABASE') | as_text }}\"\n      warehouse: \"{{ env_var('SNOWFLAKE_WAREHOUSE') | as_text }}\"\n      schema: \"{{ env_var('SNOWFLAKE_SCHEMA') | as_text }}\"\n      threads: 4\n```\n\nThird, you need to set the environment variables for your dbt profiles in the setting page of your GitHub repository. Go to Settings -\u003e Secrets and variables -\u003e New repository secret and add the above secrets:\n\n![secrets and variable setting](docs/assets/actions_secrets_variables_setting.png)\n\nFinally, you need to declare the environment variables in your GitHub workflow yaml file. This file defines the steps for running PipeRider on every pull request. You can use the following template as a reference:\n\n```yaml\nname: PR with PipeRider\n\non: [pull_request]\n\njobs:\n  piperider-compare:\n    runs-on: ubuntu-latest\n    permissions:\n      contents: read\n      pull-requests: write\n    steps:\n    - uses: actions/checkout@v3\n\n    - name: PipeRider Compare\n      uses: InfuseAI/piperider-compare-action@v1\n      env:\n        SNOWFLAKE_ACCOUNT: ${{ secrets.SNOWFLAKE_ACCOUNT }}\n        SNOWFLAKE_USER: ${{ secrets.SNOWFLAKE_USER }}\n        SNOWFLAKE_PASSWORD: ${{ secrets.SNOWFLAKE_PASSWORD }}\n        SNOWFLAKE_ROLE: ${{ secrets.SNOWFLAKE_ROLE }}\n        SNOWFLAKE_DATABASE: ${{ secrets.SNOWFLAKE_DATABASE }}\n        SNOWFLAKE_WAREHOUSE: ${{ secrets.SNOWFLAKE_WAREHOUSE }}\n        SNOWFLAKE_SCHEMA: ${{ secrets.SNOWFLAKE_SCHEMA }}\n```\n\n### (Optional) PipeRider Cloud Usage\n\n\u003cdetails\u003e\u003csummary\u003eHost results on PipeRider Cloud by:\u003c/summary\u003e\n  \nPipeRider Cloud provides an interface for navigating, generating additional comparisons, and sharing results with team members. To use PipeRider Cloud:\n\n1. [Sign up for PipeRider Cloud](https://cloud.piperider.io/signup) to obtain your `cloud_api_token`. Your default cloud project will come with a `cloud_project` id.\n2. Add `cloud_api_token` and `cloud_project` parameters to your Action like so:\n\n```yaml\nname: PR with PipeRider\n\non: [pull_request]\n\njobs:\n  piperider-compare:\n    runs-on: ubuntu-latest\n    permissions:\n      pull-requests: write\n    steps:\n    - uses: actions/checkout@v3\n\n    - name: PipeRider Compare\n      uses: InfuseAI/piperider-compare-action@v1\n      with:\n        cloud_api_token: ${{ secrets.API_TOKEN }}\n        cloud_project: ${{ secrets.PROJECT }}\n        upload: true\n        share: true\n```\n\nThe **`upload`** parameter, the action will upload the comparison result to the cloud. The **`share`** parameter is used to generate a shareable link for the comparison result.\n  \n\u003c/details\u003e\n\nWe hope these guidelines will help you use the PipeRider Compare Action effectively in your projects.\n\n\u003chr/\u003e\n\n### **Inputs for PipeRider Compare Action**\n\nThe following inputs are available for the PipeRider Compare Action. You can use these inputs to customize the comparison process according to your requirements.\n\n### Basic Parameters\n\nThe following basic parameters are available:\n\n| Input | Required | Description |\n| --- | --- | --- |\n| github_token | No | This input is optional and can be set as GITHUB_TOKEN or as a personal access token with repository access. The default value is ${{ github.token }}. |\n| recipe | No | This input is optional and allows you to specify the recipe to use for the comparison. If not specified, the default recipe located at .piperider/compare/default.yml will be used. |\n| working_directory | No | This input is optional and allows you to specify the working directory to use for the comparison. If not specified, the default working directory will be used. |\n| modified | No | Only compare the modified models if set to `True`. |\n| select | No | Specify the dbt nodes to include. |\n| skip_datasource | No | Skip accessing the connection of datasource. |\n| piperider_version | No | This input is optional and allows you to specify the version of PipeRider to use for the comparison. If not specified, the latest version will be used. |\n### (Optional) PipeRider Cloud Parameters\n\u003cdetails\u003e\u003csummary\u003eThe following parameters are available for using PipeRider Cloud:\u003c/summary\u003e\n\n  These parameters only work when the **`cloud_api_token`** has been set.\n\n  | Input | Required | Description |\n  | --- | --- | --- |\n  | cloud_api_token | No | This input is optional and allows you to specify the API token to use for the PipeRider Cloud API. If not specified, the default API token will be used. |\n  | cloud_project | No | This input is optional and allows you to specify the cloud project to use for the comparison. If not specified, the default project will be used. |\n  | upload | No | This input is optional and allows you to specify whether to upload the comparison results to PipeRider Cloud. If set to true, the comparison results will be uploaded. The default value is false. |\n  | share | No | This input is optional and allows you to specify whether to create a share link for the comparison results. If set to true, a share link will be created. The default value is false. |\n  \n\u003c/details\u003e\n\nWe hope this guide will help you use the PipeRider Compare Action more effectively.\n\n\n### **Outputs**\n\nThis GitHub Action provides two outputs that can be used in subsequent steps in the same job:\n\n- **`status`**: The exit code status of the PipeRider comparison. This indicates whether the comparison was successful or not.\n- **`uuid`**: The UUID of the repository that was compared.\n\n## **Support**\n\nIf you encounter any issues or have any questions about the PipeRider Compare Action, please **[open an issue](https://github.com/InfuseAI/piperider-compare-action/issues/new)**.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finfuseai%2Fpiperider-compare-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finfuseai%2Fpiperider-compare-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finfuseai%2Fpiperider-compare-action/lists"}