{"id":17110552,"url":"https://github.com/stephenyeargin/hubot-github-deployments","last_synced_at":"2025-07-25T17:10:28.778Z","repository":{"id":27217368,"uuid":"30688443","full_name":"stephenyeargin/hubot-github-deployments","owner":"stephenyeargin","description":"🚀🤖 Integrate with the GitHub deployment API","archived":false,"fork":false,"pushed_at":"2025-02-23T04:31:31.000Z","size":1515,"stargazers_count":6,"open_issues_count":0,"forks_count":5,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-11T16:56:44.443Z","etag":null,"topics":["deployments","github-api","hacktoberfest","hubot","hubot-scripts"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/hubot-github-deployments","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/stephenyeargin.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":"2015-02-12T06:07:46.000Z","updated_at":"2025-02-23T04:31:14.000Z","dependencies_parsed_at":"2024-03-28T19:51:47.897Z","dependency_job_id":"2b562e28-b155-4fc4-8049-23cc19bac9cb","html_url":"https://github.com/stephenyeargin/hubot-github-deployments","commit_stats":{"total_commits":77,"total_committers":8,"mean_commits":9.625,"dds":0.5064935064935066,"last_synced_commit":"9dddeeafbaaeb27b7e748293c15263959c1c1ad3"},"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stephenyeargin%2Fhubot-github-deployments","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stephenyeargin%2Fhubot-github-deployments/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stephenyeargin%2Fhubot-github-deployments/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stephenyeargin%2Fhubot-github-deployments/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stephenyeargin","download_url":"https://codeload.github.com/stephenyeargin/hubot-github-deployments/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248657805,"owners_count":21140842,"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":["deployments","github-api","hacktoberfest","hubot","hubot-scripts"],"created_at":"2024-10-14T16:27:14.744Z","updated_at":"2025-04-13T02:32:24.237Z","avatar_url":"https://github.com/stephenyeargin.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Hubot GitHub Deployments\n\n[![npm version](https://badge.fury.io/js/hubot-github-deployments.svg)](http://badge.fury.io/js/hubot-github-deployments) [![Node CI](https://github.com/stephenyeargin/hubot-github-deployments/actions/workflows/nodejs.yml/badge.svg)](https://github.com/stephenyeargin/hubot-github-deployments/actions/workflows/nodejs.yml)\n\nIntegrate with GitHub deployment API.\n\n## Getting Started\n\nThis package allows you to create payloads to send to the [GitHub Deployment API](https://developer.github.com/v3/repos/deployments/), then check on the status of the deployments. Combined with a deployment tool that listens to organizational or repository [DeploymentEvent](https://developer.github.com/v3/activity/events/types/#deploymentevent) webhooks, this module can help automate that process via ChatOps.\n\n## Installation\n\nIn your hubot repository, run:\n\n`npm install hubot-github-deployments --save`\n\nThen add **hubot-github-deployments** to your `external-scripts.json`:\n\n```json\n[\"hubot-github-deployments\"]\n```\n\n## Configuration:\n\n| Environment Variable          | Required? | Description                      |\n| ----------------------------- | :-------- | -------------------------------- |\n| `HUBOT_GITHUB_TOKEN`          | Yes       | GitHub application token         |\n| `HUBOT_GITHUB_USER`           | Yes       | GitHub bot user for deployments (IRC user will be noted in deployment description) |\n| `HUBOT_GITHUB_DEPLOY_TARGETS` | Yes       | Comma-separated list of environments, e.g. `production,staging` |\n| `HUBOT_GITHUB_DEPLOY_AUTO_MERGE` | No       | Passes auto_merge parameter to the deployment `true/false` |\n| `HUBOT_GITHUB_DEPLOY_REQUIRED_CONTEXTS` | No       | Passes required_contexts parameter to the deployment `[]` |\n| `HUBOT_GITHUB_REPO`           | No        | Repository to deploy, in `:owner/:repository`` format |\n| `HUBOT_GITHUB_OWNER`          | No        | Repository owner for deploy/info `:owner`, let's us shorten `for :owner/:repository` format |\n\n## Commands:\n\n- `hubot deploy status [for :owner/:repo|:repo]` - List the status of most recent deployments\n- `hubot deploy status [id] [for :owner/:repo|:repo]` - List the statuses a particular deployment, or an optional specific status\n- `hubot deploy list targets [for :owner/:repo|:repo]` - List available deployment targets\n- `hubot deploy list branches [for :owner/:repo|:repo] [search]` - List available branches, filtered by optional search term\n- `hubot deploy \u003cbranch or SHA\u003e to \u003cserver\u003e [for :owner/:repo|:repo]` - Creates a Github deployment of a branch/SHA to a server\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstephenyeargin%2Fhubot-github-deployments","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstephenyeargin%2Fhubot-github-deployments","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstephenyeargin%2Fhubot-github-deployments/lists"}