{"id":22840946,"url":"https://github.com/mkloubert/vscode-git-notify","last_synced_at":"2025-04-28T10:50:53.023Z","repository":{"id":71664182,"uuid":"115830559","full_name":"mkloubert/vscode-git-notify","owner":"mkloubert","description":"Visual Studio Code extension, which receives and shows git events from webhooks.","archived":false,"fork":false,"pushed_at":"2017-12-31T18:00:03.000Z","size":702,"stargazers_count":11,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-30T08:51:16.254Z","etag":null,"topics":["bitbucket-webhooks","git","gitea","github-webhooks","gitlab-webhook","http-server","https-server","json-api","notify","vscode-extension","webhooks"],"latest_commit_sha":null,"homepage":"https://marketplace.visualstudio.com/items?itemName=mkloubert.vscode-git-notify","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mkloubert.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2017-12-30T23:17:38.000Z","updated_at":"2024-08-29T05:43:26.000Z","dependencies_parsed_at":"2023-03-04T07:00:27.749Z","dependency_job_id":null,"html_url":"https://github.com/mkloubert/vscode-git-notify","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkloubert%2Fvscode-git-notify","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkloubert%2Fvscode-git-notify/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkloubert%2Fvscode-git-notify/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkloubert%2Fvscode-git-notify/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mkloubert","download_url":"https://codeload.github.com/mkloubert/vscode-git-notify/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251299903,"owners_count":21567329,"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":["bitbucket-webhooks","git","gitea","github-webhooks","gitlab-webhook","http-server","https-server","json-api","notify","vscode-extension","webhooks"],"created_at":"2024-12-13T01:14:04.181Z","updated_at":"2025-04-28T10:50:53.014Z","avatar_url":"https://github.com/mkloubert.png","language":"TypeScript","funding_links":["https://paypal.me/MarcelKloubert"],"categories":[],"sub_categories":[],"readme":"# vscode-git-notify\n\n[![Share via Facebook](https://raw.githubusercontent.com/mkloubert/vscode-git-notify/master/img/share/Facebook.png)](https://www.facebook.com/sharer/sharer.php?u=https%3A%2F%2Fmarketplace.visualstudio.com%2Fitems%3FitemName%3Dmkloubert.vscode-git-notify\u0026quote=Git%20Notify) [![Share via Twitter](https://raw.githubusercontent.com/mkloubert/vscode-git-notify/master/img/share/Twitter.png)](https://twitter.com/intent/tweet?source=https%3A%2F%2Fmarketplace.visualstudio.com%2Fitems%3FitemName%3Dmkloubert.vscode-git-notify\u0026text=Git%20Notify:%20https%3A%2F%2Fmarketplace.visualstudio.com%2Fitems%3FitemName%3Dmkloubert.vscode-git-notify\u0026via=mjkloubert) [![Share via Google+](https://raw.githubusercontent.com/mkloubert/vscode-git-notify/master/img/share/Google+.png)](https://plus.google.com/share?url=https%3A%2F%2Fmarketplace.visualstudio.com%2Fitems%3FitemName%3Dmkloubert.vscode-git-notify) [![Share via Pinterest](https://raw.githubusercontent.com/mkloubert/vscode-git-notify/master/img/share/Pinterest.png)](http://pinterest.com/pin/create/button/?url=https%3A%2F%2Fmarketplace.visualstudio.com%2Fitems%3FitemName%3Dmkloubert.vscode-git-notify\u0026description=Visual%20Studio%20Code%20extension%2C%20which%20receives%20and%20shows%20git%20events%20from%20webhooks.) [![Share via Reddit](https://raw.githubusercontent.com/mkloubert/vscode-git-notify/master/img/share/Reddit.png)](http://www.reddit.com/submit?url=https%3A%2F%2Fmarketplace.visualstudio.com%2Fitems%3FitemName%3Dmkloubert.vscode-git-notify\u0026title=Git%20Notify) [![Share via LinkedIn](https://raw.githubusercontent.com/mkloubert/vscode-git-notify/master/img/share/LinkedIn.png)](http://www.linkedin.com/shareArticle?mini=true\u0026url=https%3A%2F%2Fmarketplace.visualstudio.com%2Fitems%3FitemName%3Dmkloubert.vscode-git-notify\u0026title=Git%20Notify\u0026summary=Visual%20Studio%20Code%20extension%2C%20which%20receives%20and%20shows%20git%20events%20from%20webhooks.\u0026source=https%3A%2F%2Fmarketplace.visualstudio.com%2Fitems%3FitemName%3Dmkloubert.vscode-git-notify) [![Share via Wordpress](https://raw.githubusercontent.com/mkloubert/vscode-git-notify/master/img/share/Wordpress.png)](http://wordpress.com/press-this.php?u=https%3A%2F%2Fmarketplace.visualstudio.com%2Fitems%3FitemName%3Dmkloubert.vscode-git-notify\u0026quote=Git%20Notify\u0026s=Visual%20Studio%20Code%20extension%2C%20which%20receives%20and%20shows%20git%20events%20from%20webhooks.) [![Share via Email](https://raw.githubusercontent.com/mkloubert/vscode-git-notify/master/img/share/Email.png)](mailto:?subject=Git%20Notify\u0026body=Visual%20Studio%20Code%20extension%2C%20which%20receives%20and%20shows%20git%20events%20from%20webhooks.:%20https%3A%2F%2Fmarketplace.visualstudio.com%2Fitems%3FitemName%3Dmkloubert.vscode-git-notify)\n\n\n[![Latest Release](https://vsmarketplacebadge.apphb.com/version-short/mkloubert.vscode-git-notify.svg)](https://marketplace.visualstudio.com/items?itemName=mkloubert.vscode-git-notify)\n[![Installs](https://vsmarketplacebadge.apphb.com/installs/mkloubert.vscode-git-notify.svg)](https://marketplace.visualstudio.com/items?itemName=mkloubert.vscode-git-notify)\n[![Rating](https://vsmarketplacebadge.apphb.com/rating-short/mkloubert.vscode-git-notify.svg)](https://marketplace.visualstudio.com/items?itemName=mkloubert.vscode-git-notify#review-details)\n\n[Visual Studio Code](https://code.visualstudio.com) extension, which receives and shows git events from webhooks.\n\n\u003ckbd\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/mkloubert/vscode-git-notify/master/img/demo.gif\"\u003e\n\u003c/kbd\u003e\n\n## Table of contents\n\n1. [Install](#install-)\n2. [How to use](#how-to-use-)\n   * [Settings](#settings-)\n     * [Bitbucket](#bitbucket-)\n     * [GitHub](#github-)\n     * [Gitea](#gitea-)\n     * [GitLab](#gitlab-)\n     * [Secure HTTP](#secure-http-)\n3. [Support and contribute](#support-and-contribute-)\n\n## Install [[\u0026uarr;](#table-of-contents)]\n\nLaunch VS Code Quick Open (`Ctrl + P`), paste the following command, and press enter:\n\n```bash\next install vscode-git-notify\n```\n\nOr search for things like `vscode-git-notify` in your editor.\n\n## How to use [[\u0026uarr;](#table-of-contents)]\n\n### Settings [[\u0026uarr;](#how-to-use-)]\n\nOpen (or create) your `settings.json` in your `.vscode` subfolder of your workspace.\n\nAdd a `deploy.reloaded` section and one or more \"watchers\":\n\n```json\n{\n    \"git.notify\": {\n    }\n}\n```\n\nThe following providers and events are supported:\n\n| Event | [Bitbucket](https://bitbucket.org) | [GitHub](https://github.com) | [Gitea](https://gitea.io) | [GitLab](https://gitlab.com)\n| ---- |:--:|:--:|:--:|:--:|\n| Closed issues | X | X | | X |\n| Closed pull requests | X | X | X | X |\n| New commit / push | X | X | X | X |\n| New issues | X | X | | X |\n| New issue comments | X | X | | X |\n| New pull requests | X | X | X | X |\n| Re-opened issues | X | X | | X |\n| Re-opened pull requests | | X | X | X |\n\n#### Bitbucket [[\u0026uarr;](#settings-)]\n\nFirst you have to create a webhook for your repository.\n\nClick on the `Settings` on the left side, then on `Add webhook` button in `Webhooks`:\n\n\u003ckbd\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/mkloubert/vscode-git-notify/master/img/bitbucket_webhooks_1.png\"\u003e\n\u003c/kbd\u003e\n\nSetup the URL, that should be called for an event. This URL must be able to redirect to your machine, where your VS Code instance runs. For that, you should check your firewall settings.\n\n\u003ckbd\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/mkloubert/vscode-git-notify/master/img/bitbucket_webhooks_2.png\"\u003e\n\u003c/kbd\u003e\n\n```json\n{\n    \"git.notify\": {\n        \"watchers\": {\n            \"23979\": [\n                {\n                    \"provider\": \"bitbucket\"\n                }\n            ]\n        }\n    }\n}\n```\n\nThis will open a HTTP server instance on your machine on port `23979` on startup.\n\n#### GitHub [[\u0026uarr;](#settings-)]\n\nFirst you have to create a webhook for your repository.\n\nClick on the `Settings` tab and select `Webhooks` on the left side:\n\n\u003ckbd\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/mkloubert/vscode-git-notify/master/img/github_webhooks_1.png\"\u003e\n\u003c/kbd\u003e\n\nClick on `Add webhook` button:\n\n\u003ckbd\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/mkloubert/vscode-git-notify/master/img/github_webhooks_2.png\"\u003e\n\u003c/kbd\u003e\n\nSetup the URL, that should be called for an event. This URL must be able to redirect to your machine, where your VS Code instance runs. For that, you should check your firewall settings.\n\n\u003ckbd\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/mkloubert/vscode-git-notify/master/img/github_webhooks_3.png\"\u003e\n\u003c/kbd\u003e\n\nNow, you can define a watcher in your settings (it is recommended to do this globally - `CTRL + ,` / `CMD + ,`):\n\n```json\n{\n    \"git.notify\": {\n        \"watchers\": {\n            \"80\": [\n                {\n                    \"secret\": \"Test123\"\n                }\n            ]\n        }\n    }\n}\n```\n\nThis will open a HTTP server instance on your machine on port `80` on startup, by using `Test123` as secret expression as defined in the webhooks settings.\n\n#### Gitea [[\u0026uarr;](#settings-)]\n\nFirst you have to create a webhook for your repository.\n\nClick on the `Settings` tab, select `Webhooks` sub-tab and click on `Add Webhook / Gitea`:\n\n\u003ckbd\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/mkloubert/vscode-git-notify/master/img/gitea_webhooks_1.png\"\u003e\n\u003c/kbd\u003e\n\nSetup the URL, that should be called for an event. This URL must be able to redirect to your machine, where your VS Code instance runs. For that, you should check your firewall settings.\n\n\u003ckbd\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/mkloubert/vscode-git-notify/master/img/gitea_webhooks_2.png\"\u003e\n\u003c/kbd\u003e\n\nNow, you can define a watcher in your settings (it is recommended to do this globally - `CTRL + ,` / `CMD + ,`):\n\n```json\n{\n    \"git.notify\": {\n        \"watchers\": {\n            \"8080\": [\n                {\n                    \"provider\": \"gitea\",\n\n                    \"secret\": \"Test123\"\n                }\n            ]\n        }\n    }\n}\n```\n\nThis will open a HTTP server instance on your machine on port `8080` on startup, by using `Test123` as secret expression as defined in the webhooks settings.\n\n#### GitLab [[\u0026uarr;](#settings-)]\n\nFirst you have to create a webhook for your repository.\n\nClick on the `Settings` on the left side and click on `Integrations`:\n\n\u003ckbd\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/mkloubert/vscode-git-notify/master/img/gitlab_webhooks_1.png\"\u003e\n\u003c/kbd\u003e\n\nSetup the URL, that should be called for an event. This URL must be able to redirect to your machine, where your VS Code instance runs. For that, you should check your firewall settings.\n\n\u003ckbd\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/mkloubert/vscode-git-notify/master/img/gitlab_webhooks_2.png\"\u003e\n\u003c/kbd\u003e\n\n```json\n{\n    \"git.notify\": {\n        \"watchers\": {\n            \"5979\": [\n                {\n                    \"provider\": \"gitlab\",\n\n                    \"secret\": \"Test123\"\n                }\n            ]\n        }\n    }\n}\n```\n\nThis will open a HTTP server instance on your machine on port `5979` on startup, by using `Test123` as secret expression as defined in the webhooks settings.\n\n#### Secure HTTP [[\u0026uarr;](#settings-)]\n\nIt is highly recommended, to setup secure HTTPS instead of plain HTTP:\n\n```json\n{\n    \"git.notify\": {\n        \"watchers\": {\n            \"443\": [\n                {\n                    \"secure\": true,\n\n                    \"ca\": \"/path/to/ssl/fullchain.pem\",\n                    \"cert\": \"/path/to/ssl/cert.pem\",\n                    \"key\": \"/path/to/ssl/privkey.pem\",\n\n                    \"secret\": \"Test 1 2 3\"\n                }\n            ]\n        }\n    }\n}\n```\n\nYou can also use relative paths for the SSL files, of course. Those paths are tried to be mapped in the following order:\n\n* `${HOME_DIR}/.ssl`\n* `${WORKSPACE}/.vscode` (works also with [multi workspaces](https://code.visualstudio.com/docs/editor/multi-root-workspaces))\n\nIf you use a self-signed certificate, you should disable SSL verification in your git provider / hoster.\n\nIn GitHub, e.g., you have to click on `Disable SSL verification` button, when adding a web hook:\n\n\u003ckbd\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/mkloubert/vscode-git-notify/master/img/github_webhooks_4.png\"\u003e\n\u003c/kbd\u003e\n\n## Support and contribute [[\u0026uarr;](#table-of-contents)]\n\nIf you like the extension, you can support the project by sending a [donation via PayPal](https://paypal.me/MarcelKloubert) to [me](https://github.com/mkloubert).\n\nTo contribute, you can [open an issue](https://github.com/mkloubert/vscode-git-notify/issues) and/or fork this repository.\n\nTo work with the code:\n\n* clone [this repository](https://github.com/mkloubert/vscode-git-notify)\n* create and change to a new branch, like `git checkout -b my_new_feature`\n* run `npm install` from your project folder\n* open that project folder in Visual Studio Code\n* now you can edit and debug there\n* commit your changes to your new branch and sync it with your forked GitHub repo\n* make a [pull request](https://github.com/mkloubert/vscode-git-notify/pulls)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmkloubert%2Fvscode-git-notify","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmkloubert%2Fvscode-git-notify","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmkloubert%2Fvscode-git-notify/lists"}