{"id":13528245,"url":"https://github.com/visionmedia/deploy","last_synced_at":"2025-05-16T18:09:32.394Z","repository":{"id":1530884,"uuid":"1815167","full_name":"visionmedia/deploy","owner":"visionmedia","description":"Minimalistic deployment shell script","archived":false,"fork":false,"pushed_at":"2019-01-19T14:05:58.000Z","size":97,"stargazers_count":1154,"open_issues_count":18,"forks_count":137,"subscribers_count":37,"default_branch":"master","last_synced_at":"2025-04-12T17:00:21.342Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"graphserver/graphserver","license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/visionmedia.png","metadata":{"files":{"readme":"Readme.md","changelog":"History.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2011-05-28T19:09:54.000Z","updated_at":"2025-04-08T16:00:26.000Z","dependencies_parsed_at":"2022-08-16T13:40:10.242Z","dependency_job_id":null,"html_url":"https://github.com/visionmedia/deploy","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/visionmedia%2Fdeploy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/visionmedia%2Fdeploy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/visionmedia%2Fdeploy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/visionmedia%2Fdeploy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/visionmedia","download_url":"https://codeload.github.com/visionmedia/deploy/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254582907,"owners_count":22095518,"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-08-01T06:02:21.088Z","updated_at":"2025-05-16T18:09:32.360Z","avatar_url":"https://github.com/visionmedia.png","language":"Shell","funding_links":[],"categories":["Shell"],"sub_categories":[],"readme":"\n# deploy\n\n  Minimalistic deployment shell script.\n\n## Installation\n\n    $ make install\n\n  Visit the [wiki](https://github.com/visionmedia/deploy/wiki) for additional usage information.\n\n## Usage\n\n\n      Usage: deploy [options] \u003cenv\u003e [command]\n\n      Options:\n\n        -C, --chdir \u003cpath\u003e   change the working directory to \u003cpath\u003e\n        -c, --config \u003cpath\u003e  set config path. defaults to ./deploy.conf\n        -T, --no-tests       ignore test hook\n        -V, --version        output program version\n        -h, --help           output help information\n\n      Commands:\n\n        setup                run remote setup commands\n        update               update deploy to the latest release\n        revert [n]           revert to [n]th last deployment or 1\n        config [key]         output config file or [key]\n        curr[ent]            output current release commit\n        prev[ious]           output previous release commit\n        exec|run \u003ccmd\u003e       execute the given \u003ccmd\u003e\n        console              open an ssh session to the host\n        list                 list previous deploy commits\n        [ref]                deploy to [ref], the 'ref' setting, or latest tag\n\n## Configuration\n\n By default `deploy(1)` will look for _./deploy.conf_, consisting of one or more environments, `[stage]`, `[production]`, etc, followed by directives.\n\n    [stage]\n    key /path/to/some.pem\n    user deployer\n    host n.n.n.n\n    port nn\n    repo git@github.com:visionmedia/express.git\n    path /var/www/myapp.com\n    ref origin/master\n    post-deploy /var/www/myapp.com/update.sh\n\n## Directives\n\n### key (optional)\n\n  Path to identity file used by `ssh -i`.\n\n      key /path/to/some.pem\n\n### ref (optional)\n\n  When specified, __HEAD__ is reset to `ref`. When deploying\n  production typically this will _not_ be used, as `deploy(1)` will\n  utilize the most recent tag by default, however this is useful\n  for a staging environment, as shown below where __HEAD__ is updated\n  and set to the develop branch.\n\n        ref origin/develop\n\n### user\n\n  User for deployment.\n\n       user deployer\n\n### host\n\n  Server hostname.\n\n       host 50.17.255.50\n\n### port (optional)\n\n  Server port.\n\n       port 22\n\n### repo\n\n  GIT repository to clone.\n\n       repo git@github.com:visionmedia/express.git\n\n### path\n\n  Deployment path.\n\n        path /var/www/myapp.com\n\n### forward-agent\n\n  Webhosts normally use read-only deploy keys to access private git repositories.\n  If you'd rather use the credentials of the person invoking the deploy\n  command, put `forward-agent yes` in the relevant config sections.\n  Now the deploy script will invoke `ssh -A` when deploying and there's\n  no need to keep SSH keys on your servers.\n\n### needs_tty\n\n  If your deployment scripts require any user interaction (which they shouldn't, but\n  often do) you'll probably want SSH to allocate a tty for you. Put `needs_tty yes`\n  in the config section if you'd like the deploy script to invoke `ssh -t` and ensure\n  you have a tty available.\n\n## Hooks\n\n  All hooks are arbitrary commands, executed relative to `path/current`,\n  aka the previous deployment for `pre-deploy`, and the new deployment\n  for `post-deploy`. Of course you may specify absolute paths as well.\n\n### pre-deploy\n\n      pre-deploy ./bin/something\n\n### post-deploy\n\n      post-deploy ./bin/restart\n\n### test\n\n  Post-deployment test command after `post-deploy`. If this\n  command fails, `deploy(1)` will attempt to revert to the previous\n  deployment, ignoring tests (for now), as they are assumed to have run correctly.\n\n      test ./something\n\n## License\n\n(The MIT License)\n\nCopyright (c) 2011 TJ Holowaychuk \u0026lt;tj@vision-media.ca\u0026gt;\n\nPermission is hereby granted, free of charge, to any person obtaining\na copy of this software and associated documentation files (the\n'Software'), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\nIN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\nCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\nTORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\nSOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvisionmedia%2Fdeploy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvisionmedia%2Fdeploy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvisionmedia%2Fdeploy/lists"}