{"id":18974975,"url":"https://github.com/bufferapp/buffer-service-brigade-scripts","last_synced_at":"2026-04-08T18:30:17.606Z","repository":{"id":65840766,"uuid":"141638934","full_name":"bufferapp/buffer-service-brigade-scripts","owner":"bufferapp","description":"NPM Package for brigade scripts","archived":false,"fork":false,"pushed_at":"2018-08-13T19:25:35.000Z","size":32,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-02-01T11:03:46.295Z","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/bufferapp.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}},"created_at":"2018-07-19T23:04:44.000Z","updated_at":"2019-09-23T08:45:50.000Z","dependencies_parsed_at":"2023-02-13T14:10:13.698Z","dependency_job_id":null,"html_url":"https://github.com/bufferapp/buffer-service-brigade-scripts","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bufferapp%2Fbuffer-service-brigade-scripts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bufferapp%2Fbuffer-service-brigade-scripts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bufferapp%2Fbuffer-service-brigade-scripts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bufferapp%2Fbuffer-service-brigade-scripts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bufferapp","download_url":"https://codeload.github.com/bufferapp/buffer-service-brigade-scripts/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239972513,"owners_count":19727394,"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-08T15:16:51.117Z","updated_at":"2026-04-08T18:30:17.522Z","avatar_url":"https://github.com/bufferapp.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# buffer-service-brigade-scripts\n\nNPM Package for brigade scripts\n\n## Table Of Contents\n\n- [Quickstart](#quickstart)\n- [Example Configuration](#example-configuration)\n\n## Quickstart\n\n### Create A Brigade Project\n\nA brigade project uses a secret to be used as configuration, sensitive information can be stored in the file that can be used during the deployment phase -- things like ENV vars with keys.\n\nCreate an example brigade secret file (lets call in my-app-secrets.yaml): https://github.com/Azure/brigade/blob/master/docs/topics/github.md#configuring-your-project\n\n\nDeploy the brigade project with helm\n\n```sh\nhelm upgrade --install my-app-secrets brigade/brigade-project -f my-app-secrets.yaml --namespace brigade\n```\n\n### Hook Up The Webhook on github\n\nFollow these instructions on the repo you'd like to deploy with `https://brigade-gateway.buffer.com/events/github` as YOUR_HOSTNAME:\n\nhttps://github.com/Azure/brigade/blob/master/docs/topics/github.md#configuring-github\n\n### Configure The Repo\n\nThere are usually three parts to this\n\n- values.yaml [example](https://github.com/bufferapp/helm-chart-base-templates/blob/master/buffer-service/values.yaml)\n- brigade.js [example](https://github.com/bufferapp/core-authentication-service/blob/master/brigade.js)\n- brigade.json [example](https://github.com/bufferapp/core-authentication-service/blob/master/brigade.json)\n\nA full list of configuration options for this package can be found in the [Example Configuration](#example-configuration) section.\n\n## Example Configuration\n\n### brigade.js\n\nThis script gets called that triggers deployments\n\n```js\nconst brigade = require('brigadier')\nconst brigadeScripts = require('@bufferapp/buffer-service-brigade-scripts')\n\nbrigadeScripts({\n  brigade,\n  chartmuseumUrl: 'http://chartmuseum-chartmuseum.default', // default\n  valuesPath: 'values.yaml', // default\n  helmChart: 'buffer-service', // default\n  // environment vars to set on container\n  // (on top of any set in the values.yaml)\n  envVars: [\n    {\n      name: 'MONGO_URL',\n      projectSecret: 'MONGO_URL',\n    },\n    {\n      name: 'MONGO_DATABASE',\n      projectSecret: 'MONGO_DATABASE',\n    },\n    {\n      name: 'BUGSNAG_KEY',\n      projectSecret: 'BUGSNAG_KEY',\n    },\n    // can also specify a value if you wanted to\n    // {\n    //   name: 'SOME_ENV_VAR_NAME',\n    //   value: 'SOME_ENV_VAR_VALUE',\n    // },\n  ],\n  // deploy to a namespace when a branch PR is opened or synced\n  // destroys when the PR is closed\n  // chooses the first namespace in the list where the branch matches the regex\n  // this one does all dev deploys onto the dev namespace\n  devDeploys: [\n    // {\n    //   branch: /^reply-dev$/,\n    //   namespace: 'reply-dev',\n    // },\n    {\n      branch: /.*/,\n      namespace: 'dev',\n    },\n  ],\n  // set to true to do a dry run on PR opened or synced\n  // overrides devDeploys\n  // does not change default branch behavior\n  deployDryRun: false,\n})\n```\n\n### brigade.json\n\nDescribes which version of the scripts to use\n\n```json\n{\n  \"dependencies\": {\n    \"@bufferapp/buffer-service-brigade-scripts\": \"0.0.1\"\n  }\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbufferapp%2Fbuffer-service-brigade-scripts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbufferapp%2Fbuffer-service-brigade-scripts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbufferapp%2Fbuffer-service-brigade-scripts/lists"}