{"id":5806895,"name":"pullpreview/action","ecosystem":"actions","description":"Ephemeral preview deployments of your app for every pull request. Just using Docker Compose.","homepage":"https://pullpreview.com","licenses":"other","normalized_licenses":["Other"],"repository_url":"https://github.com/pullpreview/action","keywords_array":["action","aws","branch","continuous-deployment","continuous-integration","deploy","deployment","docker","docker-compose","ephemeral-environments","github-actions","preview-environment","pull-request","staging"],"namespace":"pullpreview","versions_count":22,"first_release_published_at":"2020-04-15T20:14:22.000Z","latest_release_published_at":"2026-02-13T20:11:38.000Z","latest_release_number":"v6.1.1","last_synced_at":"2026-04-22T10:51:59.634Z","created_at":"2023-01-04T16:34:40.191Z","updated_at":"2026-04-22T10:51:59.635Z","registry_url":"https://github.com/pullpreview/action","install_command":null,"documentation_url":null,"metadata":{"name":"Preview Environments for GitHub","description":"Ephemeral preview deployments of your app for every pull request. Just using Docker Compose.","author":"Cyril Rohr","branding":{"icon":"anchor","color":"purple"},"inputs":{"app_path":{"description":"The path to your application containing a docker-compose file","default":".","required":false},"dns":{"description":"Which DNS suffix to use","default":"my.preview.run"},"max_domain_length":{"description":"Maximum length of fully qualified domain name. Note that it cannot be greater than 62 characters due to LetsEncrypt restrictions.","default":"62"},"label":{"description":"Label to use for triggering preview deployments","default":"pullpreview"},"github_token":{"description":"The GitHub access token used to perform GitHub API operations (labels, comments, collaborator/keys lookup).","default":"${{ github.token }}"},"admins":{"description":"Logins of GitHub users that will have their SSH key installed on the instance, comma-separated","required":false,"default":"@collaborators/push"},"ports":{"description":"Ports to open for external access on the preview server (port 22 is always open), comma-separated","required":false,"default":"80/tcp,443/tcp"},"cidrs":{"description":"The IP address, or range of IP addresses in CIDR notation, that are allowed to connect to the instance","required":false,"default":"0.0.0.0/0"},"default_port":{"description":"The port to use when building the preview URL","required":false,"default":"80"},"compose_files":{"description":"Compose files to use when running docker-compose up, comma-separated","required":false,"default":"docker-compose.yml"},"compose_options":{"description":"Additional options to pass to docker-compose up, comma-separated","required":false,"default":"--build"},"license":{"description":"PullPreview license","required":false,"default":""},"instance_type":{"description":"Instance type to use","required":false,"default":"small"},"region":{"description":"Provider region (AWS region or Hetzner location), overrides provider defaults","required":false,"default":""},"deployment_variant":{"description":"Deployment variant, which allows launching multiple deployments per PR (4 chars max)","required":false,"default":""},"image":{"description":"Instance image (Hetzner only; ignored by AWS)","required":false,"default":"ubuntu-24.04"},"provider":{"description":"Cloud provider to use: lightsail, hetzner","required":false,"default":"lightsail"},"registries":{"description":"Names of private registries to authenticate against. E.g. docker://username:password@ghcr.io","required":false,"default":""},"proxy_tls":{"description":"Enable automatic HTTPS forwarding with Let's Encrypt (format: service:port, e.g. web:80)","required":false,"default":""},"pre_script":{"description":"Path to a local bash script (relative to app_path) executed inline over SSH on the instance before docker compose","required":false,"default":""},"ttl":{"description":"Maximum time to live for deployments (e.g. 10h, 5d, infinite)","required":false,"default":"infinite"}},"outputs":{"live":{"description":"Whether this run produced a live preview deployment","value":"${{ steps.pullpreview.outputs.live }}"},"url":{"description":"The URL of the application on the preview server","value":"${{ steps.pullpreview.outputs.url }}"},"host":{"description":"The hostname or IP address of the preview server","value":"${{ steps.pullpreview.outputs.host }}"},"username":{"description":"The username that can be used to SSH into the preview server","value":"${{ steps.pullpreview.outputs.username }}"}},"runs":{"using":"composite","steps":[{"name":"Restore SSH key cache","uses":"actions/cache@v4","with":{"path":"${{ runner.temp }}/pullpreview-ssh-keys","key":"pullpreview-ssh-keys-v1-${{ github.repository_id }}-${{ github.run_id }}","restore-keys":"pullpreview-ssh-keys-v1-${{ github.repository_id }}-\n"}},{"id":"pullpreview","shell":"bash","env":{"GITHUB_TOKEN":"${{ inputs.github_token }}","PULLPREVIEW_LICENSE":"${{ inputs.license }}","PULLPREVIEW_PROVIDER":"${{ inputs.provider }}","PULLPREVIEW_MAX_DOMAIN_LENGTH":"${{ inputs.max_domain_length }}","PULLPREVIEW_SSH_KEYS_CACHE_DIR":"${{ runner.temp }}/pullpreview-ssh-keys","PULLPREVIEW_GITHUB_JOB_ID":"${{ job.check_run_id }}"},"run":"set -euo pipefail\nmkdir -p \"${PULLPREVIEW_SSH_KEYS_CACHE_DIR}\"\n\nos=\"$(echo \"${RUNNER_OS}\" | tr '[:upper:]' '[:lower:]')\"\narch=\"$(echo \"${RUNNER_ARCH}\" | tr '[:upper:]' '[:lower:]')\"\nif [ \"${os}\" != \"linux\" ]; then\n  echo \"::error::Unsupported RUNNER_OS=${RUNNER_OS}. Only Linux amd64 is supported.\"\n  exit 1\nfi\ncase \"${arch}\" in\n  x64) arch=\"amd64\" ;;\n  amd64) arch=\"amd64\" ;;\n  *)\n    echo \"::error::Unsupported RUNNER_ARCH=${RUNNER_ARCH}. Only amd64 is supported.\"\n    exit 1\n    ;;\nesac\n\nbinary=\"${GITHUB_ACTION_PATH}/dist/pullpreview-${os}-${arch}\"\nif [ ! -f \"${binary}\" ]; then\n  echo \"::error::Bundled binary not found at ${binary}. Run 'make dist' and commit dist artifacts.\"\n  ls -la \"${GITHUB_ACTION_PATH}/dist\" || true\n  exit 1\nfi\nchmod +x \"${binary}\"\n\napp_path=\"${{ inputs.app_path }}\"\n# Backward compatibility for Docker-era defaults; composite actions run in $GITHUB_WORKSPACE.\nif [ -z \"${app_path}\" ] || [ \"${app_path}\" = \"/github/workspace\" ]; then\n  app_path=\"${GITHUB_WORKSPACE}\"\nfi\n\n\"${binary}\" github-sync \"${app_path}\" \\\n  --admins \"${{ inputs.admins }}\" \\\n  --cidrs \"${{ inputs.cidrs }}\" \\\n  --compose-files \"${{ inputs.compose_files }}\" \\\n  --compose-options \"${{ inputs.compose_options }}\" \\\n  --dns \"${{ inputs.dns }}\" \\\n  --label \"${{ inputs.label }}\" \\\n  --ports \"${{ inputs.ports }}\" \\\n  --default-port \"${{ inputs.default_port }}\" \\\n  --instance-type \"${{ inputs.instance_type }}\" \\\n  --region \"${{ inputs.region }}\" \\\n  --image \"${{ inputs.image }}\" \\\n  --deployment-variant \"${{ inputs.deployment_variant }}\" \\\n  --registries \"${{ inputs.registries }}\" \\\n  --proxy-tls \"${{ inputs.proxy_tls }}\" \\\n  --pre-script \"${{ inputs.pre_script }}\" \\\n  --ttl \"${{ inputs.ttl }}\"\n\nif grep -q '^url=' \"${GITHUB_OUTPUT}\"; then\n  echo \"live=true\" \u003e\u003e \"${GITHUB_OUTPUT}\"\nelse\n  echo \"live=false\" \u003e\u003e \"${GITHUB_OUTPUT}\"\nfi\n"}]},"default_branch":"main","path":null},"repo_metadata":{"id":37774796,"uuid":"255978101","full_name":"pullpreview/action","owner":"pullpreview","description":"A GitHub Action that starts preview deployments for your pull requests and branches. It can work with any application that has a valid Docker Compose file.","archived":false,"fork":false,"pushed_at":"2026-03-10T16:30:53.000Z","size":159823,"stargazers_count":190,"open_issues_count":7,"forks_count":16,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-03-10T21:40:31.527Z","etag":null,"topics":["action","aws","branch","continuous-deployment","continuous-integration","deploy","deployment","docker","docker-compose","ephemeral-environments","github-actions","preview-environment","pull-request","staging"],"latest_commit_sha":null,"homepage":"https://pullpreview.com","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pullpreview.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2020-04-15T16:40:36.000Z","updated_at":"2026-03-09T08:56:05.000Z","dependencies_parsed_at":"2024-02-05T13:34:18.033Z","dependency_job_id":"c9c80048-6106-48c2-b176-27bf1c5d5b22","html_url":"https://github.com/pullpreview/action","commit_stats":{"total_commits":136,"total_committers":6,"mean_commits":"22.666666666666668","dds":0.05882352941176472,"last_synced_commit":"7eecd65a3d22e642318bb63306887e9d28deaec9"},"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"purl":"pkg:github/pullpreview/action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pullpreview%2Faction","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pullpreview%2Faction/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pullpreview%2Faction/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pullpreview%2Faction/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pullpreview","download_url":"https://codeload.github.com/pullpreview/action/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pullpreview%2Faction/sbom","scorecard":{"id":749349,"data":{"date":"2025-08-11","repo":{"name":"github.com/pullpreview/action","commit":"2edc1ba5ed473d0723cbf94680a93b1c0ebb9f5b"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.6,"checks":[{"name":"Maintained","score":0,"reason":"0 commit(s) and 1 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":"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":1,"reason":"Found 4/30 approved changesets -- score normalized to 1","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":"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":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/pullpreview-multi-env.yml:1","Info: topLevel 'contents' permission set to 'read': .github/workflows/pullpreview.yml:15","Warn: topLevel 'deployments' permission set to 'write': .github/workflows/pullpreview.yml:16","Warn: topLevel 'statuses' permission set to 'write': .github/workflows/pullpreview.yml:18","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":"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":"Pinned-Dependencies","score":2,"reason":"dependency not pinned by hash detected -- score normalized to 2","details":["Info: Possibly incomplete results: error parsing shell code: a command can only contain words and redirects; encountered (: data/update_script.sh.erb:0","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pullpreview-multi-env.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/pullpreview/action/pullpreview-multi-env.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pullpreview-multi-env.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/pullpreview/action/pullpreview-multi-env.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pullpreview.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/pullpreview/action/pullpreview.yml/master?enable=pin","Info:   0 out of   3 GitHub-owned GitHubAction dependencies pinned","Info:   1 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":"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":9,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Warn: project license file does not contain an FSF or OSI license."],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"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":"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 'master'"],"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 17 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-22T19:47:59.674Z","repository_id":37774796,"created_at":"2025-08-22T19:47:59.674Z","updated_at":"2025-08-22T19:47:59.674Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30376309,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-11T06:09:32.197Z","status":"ssl_error","status_checked_at":"2026-03-11T06:09:17.086Z","response_time":84,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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"},"tags":[]},"repo_metadata_updated_at":"2026-03-11T10:14:09.992Z","dependent_packages_count":0,"downloads":null,"downloads_period":null,"dependent_repos_count":30,"rankings":{"downloads":null,"dependent_repos_count":8.02408493107273,"dependent_packages_count":0.0,"stargazers_count":1.616225637775313,"forks_count":6.753287909998415,"docker_downloads_count":2.183489145935668,"average":3.7154175249564254},"purl":"pkg:githubactions/pullpreview/action","advisories":[],"docker_usage_url":"https://docker.ecosyste.ms/usage/actions/pullpreview/action","docker_dependents_count":1,"docker_downloads_count":842,"usage_url":"https://repos.ecosyste.ms/usage/actions/pullpreview/action","dependent_repositories_url":"https://repos.ecosyste.ms/api/v1/usage/actions/pullpreview/action/dependencies","status":null,"funding_links":[],"critical":null,"issue_metadata":{"last_synced_at":"2025-08-31T13:42:09.181Z","issues_count":41,"pull_requests_count":57,"avg_time_to_close_issue":4955006.647058823,"avg_time_to_close_pull_request":1580386.0892857143,"issues_closed_count":34,"pull_requests_closed_count":56,"pull_request_authors_count":11,"issue_authors_count":25,"avg_comments_per_issue":2.682926829268293,"avg_comments_per_pull_request":0.47368421052631576,"merged_pull_requests_count":45,"bot_issues_count":0,"bot_pull_requests_count":2,"past_year_issues_count":11,"past_year_pull_requests_count":4,"past_year_avg_time_to_close_issue":1368928.25,"past_year_avg_time_to_close_pull_request":300526.0,"past_year_issues_closed_count":4,"past_year_pull_requests_closed_count":4,"past_year_pull_request_authors_count":3,"past_year_issue_authors_count":5,"past_year_avg_comments_per_issue":1.3636363636363635,"past_year_avg_comments_per_pull_request":0.0,"past_year_bot_issues_count":0,"past_year_bot_pull_requests_count":0,"past_year_merged_pull_requests_count":3,"issues_url":"https://issues.ecosyste.ms/api/v1/hosts/GitHub/repositories/pullpreview%2Faction/issues","maintainers":[{"login":"crohr","count":47,"url":"https://issues.ecosyste.ms/api/v1/hosts/GitHub/authors/crohr"},{"login":"qbonnard","count":1,"url":"https://issues.ecosyste.ms/api/v1/hosts/GitHub/authors/qbonnard"}],"active_maintainers":[]},"versions_url":"https://packages.ecosyste.ms/api/v1/registries/github%20actions/packages/pullpreview%2Faction/versions","version_numbers_url":"https://packages.ecosyste.ms/api/v1/registries/github%20actions/packages/pullpreview%2Faction/version_numbers","dependent_packages_url":"https://packages.ecosyste.ms/api/v1/registries/github%20actions/packages/pullpreview%2Faction/dependent_packages","related_packages_url":"https://packages.ecosyste.ms/api/v1/registries/github%20actions/packages/pullpreview%2Faction/related_packages","codemeta_url":"https://packages.ecosyste.ms/api/v1/registries/github%20actions/packages/pullpreview%2Faction/codemeta","maintainers":[]}