{"id":18465541,"url":"https://github.com/numtide/github-deploy","last_synced_at":"2025-04-08T08:31:55.042Z","repository":{"id":42189722,"uuid":"135925472","full_name":"numtide/github-deploy","owner":"numtide","description":"Track deployments on GitHub PRs","archived":false,"fork":false,"pushed_at":"2024-11-21T13:45:41.000Z","size":7072,"stargazers_count":14,"open_issues_count":4,"forks_count":3,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-04-02T23:55:51.074Z","etag":null,"topics":["buildbot-numtide","ci","cli","github-deployment"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/numtide.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2018-06-03T17:26:40.000Z","updated_at":"2025-03-18T17:31:02.000Z","dependencies_parsed_at":"2024-01-16T11:48:26.374Z","dependency_job_id":"8291d1af-8ac9-4f8f-86bb-df695d1f6826","html_url":"https://github.com/numtide/github-deploy","commit_stats":{"total_commits":56,"total_committers":4,"mean_commits":14.0,"dds":0.375,"last_synced_commit":"b17f6bc809adaa70e272426bd52b127deb3da285"},"previous_names":["zimbatm/github-deploy"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/numtide%2Fgithub-deploy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/numtide%2Fgithub-deploy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/numtide%2Fgithub-deploy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/numtide%2Fgithub-deploy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/numtide","download_url":"https://codeload.github.com/numtide/github-deploy/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247804587,"owners_count":20999017,"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":["buildbot-numtide","ci","cli","github-deployment"],"created_at":"2024-11-06T09:13:26.695Z","updated_at":"2025-04-08T08:31:55.036Z","avatar_url":"https://github.com/numtide.png","language":"Go","readme":"# github-deploy - Track deployments on GitHub\n\n[![built with nix](https://builtwithnix.org/badge.svg)](https://builtwithnix.org)\n\nAn opinionated command-line utility that integrates deployments with the github Deployment API.\n\n## Description\n\nThis is a wrapper command that abstracts the deployment method through a set of scripts which interfaces are clearly defined.\n\nThe wrapper command tracks the deployment statuses by interacting with the github API.\n\n## Assumptions\n\nThe command is being run in the checkout of the project that is about to be deployed, with the right\ngit commit checked out.\n\n## Usage\n\n`$ ./github-deploy --help`\n\n```\nNAME:\n   github-deploy - A CLI that integrates deployments with github\n\nUSAGE:\n   github-deploy [global options] command [command options] [arguments...]\n\nVERSION:\n   0.6.2\n\nAUTHOR:\n   zimbatm \u003czimbatm@zimbatm.com\u003e\n\nCOMMANDS:\n     please   Initiates a deployment\n     cleanup  Removes deployments\n     help, h  Shows a list of commands or help for one command\n\nGLOBAL OPTIONS:\n   --git-commit value    git commit ID [$GITHUB_SHA, $BUILDKITE_COMMIT, $CIRCLE_SHA1, $TRAVIS_PULL_REQUEST_SHA]\n   --git-branch value    git branch [$GITHUB_REF, $BUILDKITE_BRANCH, $CIRCLE_BRANCH, $TRAVIS_BRANCH]\n   --git-origin value    URL of the repo [$BUILDKITE_REPO, $CIRCLE_REPOSITORY_URL]\n   --git-ref-commit      use the commit as deployment reference instead of branch\n   --github-token value  Github Personal access token to interact with the Github API (default: \u003csecret:github-token\u003e) [$GITHUB_TOKEN]\n   --help, -h            show help\n   --version, -v         print the version\n```\n## Scripts interface\n\n### `DEPLOY_SCRIPT \u003cTARGET\u003e`\n\nThe deploy script takes an optional deployment name an argument and returns the target URL on stdout.\n\nDepending on the script exit status, the deployment is marked as a failure or success.\n\n### `LIST_SCRIPT`\n\nReturns the list of all the temporary deployments on stdout.\n\n### `UNDEPLOY_SCRIPT \u003cTARGET\u003e`\n\nDeletes a deployment named `\u003cTARGET\u003e`. Should not undeploy production.\n\n## Install\n\nTo install, use `go get`:\n\n```bash\n$ go get -d github.com/zimbatm/github-deploy\n```\n\n## Setup\n\n### Create a token\n\nGo to https://github.com/settings/tokens/new\n\nSelect `repo`\n\nexport GITHUB_TOKEN=\u003cnew-token\u003e\n\n### Create the wrapper scripts\n\nTODO example\n\n## Contribution\n\n1. Fork ([https://github.com/zimbatm/github-deploy/fork](https://github.com/zimbatm/github-deploy/fork))\n1. Create a feature branch\n1. Commit your changes\n1. Rebase your local changes against the main branch\n1. Run test suite with the `go test ./...` command and confirm that it passes\n1. Run `gofmt -s`\n1. Create a new Pull Request\n\n## Author\n\n[zimbatm](https://github.com/zimbatm)\n\n## License\n\nMIT\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnumtide%2Fgithub-deploy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnumtide%2Fgithub-deploy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnumtide%2Fgithub-deploy/lists"}