{"id":20414488,"url":"https://github.com/codecov/codecov-slack-app","last_synced_at":"2026-03-10T02:03:47.016Z","repository":{"id":196651000,"uuid":"607842426","full_name":"codecov/codecov-slack-app","owner":"codecov","description":null,"archived":false,"fork":false,"pushed_at":"2025-08-22T15:09:45.000Z","size":660,"stargazers_count":2,"open_issues_count":2,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-19T23:48:16.757Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/codecov.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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-02-28T19:37:54.000Z","updated_at":"2025-08-22T15:08:32.000Z","dependencies_parsed_at":null,"dependency_job_id":"9b30bb09-3299-4a97-b71e-9057169d9fdb","html_url":"https://github.com/codecov/codecov-slack-app","commit_stats":null,"previous_names":["codecov/codecov-slack-app"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/codecov/codecov-slack-app","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codecov%2Fcodecov-slack-app","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codecov%2Fcodecov-slack-app/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codecov%2Fcodecov-slack-app/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codecov%2Fcodecov-slack-app/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codecov","download_url":"https://codeload.github.com/codecov/codecov-slack-app/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codecov%2Fcodecov-slack-app/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30322637,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-10T01:36:58.598Z","status":"online","status_checked_at":"2026-03-10T02:00:06.579Z","response_time":106,"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":"2024-11-15T06:10:19.070Z","updated_at":"2026-03-10T02:03:42.008Z","avatar_url":"https://github.com/codecov.png","language":"Python","readme":"# Codecov Slack App \r\nCodecov Slack App Implementation for a Slack app intended to serve Codecov customers by using Codecov public API.\r\n\r\n#  Running the app locally\r\n\r\n1. Create a virtual environment in the root directory of the app:\r\n   ```\r\n   python3 -m venv venv\r\n   ```\r\n\r\n2. Activate the virtual environment:\r\n   ```\r\n   source venv/bin/activate\r\n   ```\r\n\r\n3. Install the required dependencies using pip:\r\n   ```\r\n   pip install -r requirements.txt\r\n   ```\r\n\r\n4. Install Docker:\r\n   Make sure you have Docker installed. If you do not have Docker installed, please refer to the Docker documentation to install it on your local machine.\r\n\r\n5. Start the Docker containers:\r\n   ```\r\n   make up\r\n   ```\r\n   (For the first run, `make gcr.login` may be needed.)\r\n\r\n6. Set up ngrok as a local proxy:\r\n   - Install and configure ngrok to expose a public endpoint that Slack can use to send your app events. Run the following command:\r\n     ```\r\n     ngrok http 8000\r\n     ```\r\n     Refer to [this link](https://api.slack.com/start/building/bolt-python#ngrok) to learn more about using ngrok.\r\n\r\n7. Create a Slack app:\r\n   - Go to [https://api.slack.com/apps?new_app=1\u0026ref=bolt_start_hub](https://api.slack.com/apps?new_app=1\u0026ref=bolt_start_hub) to create a new app in the Slack API. Follow the instructions provided in the link.\r\n\r\n8. Configure environment variables:\r\n   - Create an `.env` file in your local environment and copy the required tokens into it. Your `.env` file should look like this:\r\n     ```\r\n     # DB Settings\r\n     SQL_ENGINE=django.db.backends.postgresql\r\n     POSTGRES_DB=db\r\n     POSTGRES_USER=db\r\n     POSTGRES_PASSWORD=password\r\n     SQL_HOST=db\r\n     SQL_PORT=5432\r\n\r\n     # Django Settings\r\n     DJANGO_SETTINGS_MODULE=codecov_slack_app.settings\r\n     DJANGO_SECRET_KEY=secret\r\n\r\n     # Slack App Settings\r\n     SLACK_CLIENT_ID=\r\n     SLACK_CLIENT_SECRET=\r\n     SLACK_SIGNING_SECRET=\r\n     SLACK_SCOPES=chat:write,commands,users:read,users:read.email,app_mentions:read,channels:join,channels:read,files:write,groups:read,im:read,mpim:read\r\n     SLACK_REDIRECT_URI=YOUR_NGROK_TUNNEL/slack/oauth_redirect\r\n     SLACK_APP_ID=\r\n\r\n     # GitHub Slack App Settings (You'll need this if you care to test GitHub app locally)\r\n     GITHUB_APP_ID=\r\n     GITHUB_CLIENT_ID=\r\n     GITHUB_CLIENT_SECRET=\r\n     GITHUB_REDIRECT_URI=NGROK_TUNNEL_URL/auth/gh/callback\r\n\r\n     # CODECOV env variables\r\n     CODECOV_INTERNAL_TOKEN=\r\n     CODECOV_PUBLIC_API=https://stage-api.codecov.dev/api/v2\r\n     CODECOV_API_URL=https://stage-api.codecov.dev\r\n\r\n     USER_ID_SECRET=random_secret\r\n     SENTRY_ENVIRONMENT=staging\r\n\r\n     RUN_ENV=LOCAL\r\n     ```\r\n\r\n9. Update request URLs in the Slack app dashboard:\r\n   - Update the request URL in multiple areas of the Slack app dashboard with the ngrok tunnel you've created:\r\n     - Use `NGROK_TUNNEL_URL/slack/events` in [https://api.slack.com/apps/YOUR_APP_ID/interactive-messages](https://api.slack.com/apps/YOUR_APP_ID/interactive-messages)\r\n     - Use `NGROK_TUNNEL_URL/slack/events` after enabling events in [https://api.slack.com/apps/YOUR_APP_ID/event-subscriptions](https://api.slack.com/apps/YOUR_APP_ID/event-subscriptions)\r\n     - Create a command called `/codecov` in [https://api.slack.com/apps/YOUR_APP_ID/slash-commands](https://api.slack.com/apps/YOUR_APP_ID/slash-commands) and append the request URL to it\r\n     - Use `NGROK_TUNNEL_URL/slack/auth_redirect` in the redirect URLs in [https://api.slack.com/apps/YOUR_APP_ID/oauth](https://api.slack.com/apps/YOUR_APP_ID/oauth)\r\n\r\n10. Installation:\r\n    - Visit `NGROK_TUNNEL_URL/slack/install`. You should see the Slack installation page. Follow the instructions to install the app.\r\n   \r\n\r\n\r\nThat's it! 🎉 Your Slack app should now be set up and running locally.\r\n\r\nℹ️ Please note that you need to replace `YOUR_APP_ID` and `NGROK_TUNNEL_URL` with the appropriate values for your application.\r\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodecov%2Fcodecov-slack-app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodecov%2Fcodecov-slack-app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodecov%2Fcodecov-slack-app/lists"}