{"id":19658177,"url":"https://github.com/cdaringe/surge-review","last_synced_at":"2025-04-28T20:31:16.780Z","repository":{"id":18503884,"uuid":"84387792","full_name":"cdaringe/surge-review","owner":"cdaringe","description":"Deploy a static site to surge from CI \u0026 post the site to your pull request automatically :tada:","archived":false,"fork":false,"pushed_at":"2024-08-06T06:27:50.000Z","size":287,"stargazers_count":3,"open_issues_count":13,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-22T16:02:53.494Z","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/cdaringe.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,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-03-09T02:18:25.000Z","updated_at":"2022-08-08T18:28:51.000Z","dependencies_parsed_at":"2023-11-06T04:31:04.169Z","dependency_job_id":"6ef6649f-c5bf-4e19-83ab-8428da43484b","html_url":"https://github.com/cdaringe/surge-review","commit_stats":{"total_commits":38,"total_committers":5,"mean_commits":7.6,"dds":0.5526315789473684,"last_synced_commit":"89ef3f6b657d681e98eb417baee2a7336cc15238"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cdaringe%2Fsurge-review","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cdaringe%2Fsurge-review/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cdaringe%2Fsurge-review/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cdaringe%2Fsurge-review/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cdaringe","download_url":"https://codeload.github.com/cdaringe/surge-review/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251383653,"owners_count":21580916,"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-11T15:36:22.104Z","updated_at":"2025-04-28T20:31:16.370Z","avatar_url":"https://github.com/cdaringe.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# surge-review :zap:\n\n[![Greenkeeper badge](https://badges.greenkeeper.io/cdaringe/surge-review.svg)](https://greenkeeper.io/)\n\n- Deploys a static site to [surge.sh](http://surge.sh)\n- Adds a comment to your pull request with the new site URL :tada:\n\n[ ![Codeship Status for cdaringe/surge-review](https://app.codeship.com/projects/f3909050-e73f-0134-cbdd-5eb6ba68ea7b/status?branch=master)](https://app.codeship.com/projects/207094) ![](https://img.shields.io/badge/standardjs-%E2%9C%93-brightgreen.svg) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)\n\n## install\n\n`npm install --save-dev surge-review`\n\n## usage\n\n`$ surge-review`\n\nsee `surge-review -h` for common options.  generally, you will setup your CI server for your project to:\n\n- export github \u0026 surge tokens (`SURGE_LOGIN`, `SURGE_TOKEN`, \u0026 `GH_TOKEN`)\n- install this package\n- build your website\n- run `surge-review` to deploy to `surge.sh` \u0026 post a comment to github\n\n### support\n\n- gitlab is not yet supported.  the api calls used are short and sweet. open a PR if you'd like to add it!\n- github enterprise _is_ supported. see config options\n\n## configuration\n\n### required\n\n- `SURGE_LOGIN`, email address registered with surge\n- `SURGE_TOKEN`, token registered with surge\n- `GH_TOKEN`, [github oauth token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/)\n- `GH_PROJECT`, your CI should provide this.\n- `GH_OWNER`, your CI should provide this.\n  - `GH_PROJECT_OWNER`, such as 'cdaringe/surge-review' can be used in exchange for the above two. for instance, codeship offers up `CI_REPO_NAME`, which === `'cdaringe/surge-review'`, so `GH_PROJECT_OWNER=$CI_REPO_NAME` works\n- `GH_PULL_REQUEST`\n  - the _number_ of your PR.  this is the number at the end of your PR URL\n  - this isn't strictly required--`surge-review` will try to search for the PR number **iff* you also provide a `GH_PULL_BRANCH`\n\n### optional\n\n- `BUILD_ID` your `\u003csubdomain\u003e`.surge.sh is random by default. add this to make your subdomain `s`urgereview`${BUILD_ID}`\n- `GHE` set to true if publishing to GitHub Enterprise\n- `GH_DOMAIN` default: github.com\n- `GH_PROTOCOL` default: 'https'\n- `GH_FOLLOW_REDIRECTS` default: false\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcdaringe%2Fsurge-review","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcdaringe%2Fsurge-review","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcdaringe%2Fsurge-review/lists"}