{"id":28095393,"url":"https://github.com/lightdash/lightdash-cloud-announcer","last_synced_at":"2025-09-12T03:41:18.201Z","repository":{"id":62665778,"uuid":"463504793","full_name":"lightdash/lightdash-cloud-announcer","owner":"lightdash","description":"slack bot for customer support","archived":false,"fork":false,"pushed_at":"2025-06-23T11:19:06.000Z","size":1117,"stargazers_count":6,"open_issues_count":5,"forks_count":1,"subscribers_count":11,"default_branch":"main","last_synced_at":"2025-08-28T17:01:05.136Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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/lightdash.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,"zenodo":null}},"created_at":"2022-02-25T11:18:10.000Z","updated_at":"2025-06-23T11:19:10.000Z","dependencies_parsed_at":"2023-11-29T19:47:16.213Z","dependency_job_id":"1d10b0f1-6601-4ba2-85e9-a53c3c9e3b65","html_url":"https://github.com/lightdash/lightdash-cloud-announcer","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/lightdash/lightdash-cloud-announcer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightdash%2Flightdash-cloud-announcer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightdash%2Flightdash-cloud-announcer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightdash%2Flightdash-cloud-announcer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightdash%2Flightdash-cloud-announcer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lightdash","download_url":"https://codeload.github.com/lightdash/lightdash-cloud-announcer/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightdash%2Flightdash-cloud-announcer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274748734,"owners_count":25341994,"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","status":"online","status_checked_at":"2025-09-12T02:00:09.324Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":"2025-05-13T15:59:59.066Z","updated_at":"2025-09-12T03:41:18.190Z","avatar_url":"https://github.com/lightdash.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Cloudy - our community helpbot\n\n**Cloudy can query across workspaces. Only install into workspaces you trust. Controlled with `SLACK_AUTHORIZED_TEAMS`**\n\nCloudy is deployed to prod automatically on push to `main` at https://cloudy-server.onrender.com\n\nYou can develop Cloudy locally by following these steps:\n\n## Getting started\n\n```bash\n# Clone the Lightdash cloud announcer repo\ngit clone https://github.com/lightdash/lightdash-cloud-announcer.git\n```\n\n### Make sure you create and set an `.env` file correctly.\n\nℹ️ app id for \"dev Cloudy\" is `A03NM81NBFD`\n\nSLACK_SIGNING_SECRET=[Get variable from slack app settings](https://api.slack.com/apps/[APP_ID]/general)\n\nSLACK_CLIENT_ID=[Get variable from slack app settings](https://api.slack.com/apps/[APP_ID]/general)\n\nSLACK_CLIENT_SECRET=[Get variable from slack app settings](https://api.slack.com/apps/[APP_ID]/general)\n\nSLACK_STATE_SECRET=this can be anything\n\nSLACK_AUTHORIZED_TEAMS=T0163M87MB9,T03942PB7E3\n\nPG_CONNECTION_STRING=postgres://user:pass@host:port/database\n\nSITE_ENV=https://cloudy-dev-crazy-cayote.loca.lt\n\nGITHUB_WEBHOOKS_SECRET=[Create a new webhook with a secret](https://github.com/organizations/lightdash/settings/hooks)\n\nGITHUB_ACCESS_TOKEN=[Create a new access token](https://github.com/settings/tokens/new)\n\nRUDDERSTACK_WRITE_KEY=[Get your Rudderstack write key here](https://app.rudderstack.com/)\n\nRUDDERSTACK_DATA_PLANE_URL=[Get your data plane URL here](https://app.rudderstack.com/)\n\n## Setup dev\n\n### 1. Install all dependencies\n\n```bash\n# Install all the project's dependencies\nnpm install\n\n# Run the app locally\nnpm run dev\n\n# build and start\nnpm run build \u0026\u0026 npm start\n```\n\n### 2. Run cloudflared and update URLs\n\n[read more on cloudflared and custom lightdash.dev domains here](https://www.notion.so/lightdash/Generate-public-development-URLs-with-cloudflared-tunnel-proxy-13fa63207a7a800d8029e8fd36499752)\n\n```bash\nnpm expose irakli # exposes irakli.lightdash.dev domain\n```\n\nNow you need to update the URLs with the cloudflared URL:\n\n- Update the `SITE_ENV` environment variable\n- Update all domains in the `/slack-app-manifest.json`\n\n### 3. Configure slack to use our app\n\n- Create or update a slack app at `https://api.slack.com`\n- Copy in the `slack-app-manifest.json` (change command names and bot name if in dev)\n- Get all the secrets from the \"basic information\" and update:\n  - `SLACK_SIGNING_SECRET`\n  - `SLACK_CLIENT_ID`\n  - `SLACK_CLIENT_SECRET`\n\n### 4. Setup GitHub webhooks\n\nGo to webhooks and create a new webhook\n\n- Payload URL `https://[ngrok domain]/api/github/webhooks`\n- Content type: `application/json`\n- Add a secret variable (it can be anything)\n- Enable SSL\n- \"Let me select individual events\" -\u003e `Issues` only\n- Active ✔️\n\nIn the app add the following variables:\n\n```\nGITHUB_WEBHOOKS_SECRET=the secret you chose above (it can be anything but must match the one you provided to github)\nGITHUB_ACCESS_TOKEN=a personal access token for GitHub\n```\n\n### 6. Run the app locally\n\n```shell\nnpm run dev\n```\n\n### 7. Verify webhooks\n\nOnce the app is running, in your webhook settings in GitHub verify that you can receive the ping event:\n\n![CleanShot 2023-11-29 at 19 00 12@2x](https://github.com/lightdash/lightdash-cloud-announcer/assets/11660098/195add17-9e6e-46c3-8483-9598aa0b619c)\n\nIn Slack under \"event subscriptions\" check you can receive the ping event:\n\n![CleanShot 2023-11-29 at 19 01 51@2x](https://github.com/lightdash/lightdash-cloud-announcer/assets/11660098/87c3b8f8-9a7e-4fd4-ad74-2c3bc0f832ae)\n\n### 8. Install into your workspace\n\nvisit https://yourdomain.com/slack/install\n\n:info: installing from the slack app settings won't work.\n\n### Production\n\n- Update all URLs for prod deployment\n- Under \"manage distribution\" set to \"publicly available\"\n\n### Dev notes\n\n#### Add migration\n\n```shell\nnpm knex -- migrate:make \u003cmigration_name\u003e --env production\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flightdash%2Flightdash-cloud-announcer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flightdash%2Flightdash-cloud-announcer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flightdash%2Flightdash-cloud-announcer/lists"}