https://github.com/mkloubert/vscode-git-notify
Visual Studio Code extension, which receives and shows git events from webhooks.
https://github.com/mkloubert/vscode-git-notify
bitbucket-webhooks git gitea github-webhooks gitlab-webhook http-server https-server json-api notify vscode-extension webhooks
Last synced: 5 months ago
JSON representation
Visual Studio Code extension, which receives and shows git events from webhooks.
- Host: GitHub
- URL: https://github.com/mkloubert/vscode-git-notify
- Owner: mkloubert
- License: lgpl-3.0
- Created: 2017-12-30T23:17:38.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-12-31T18:00:03.000Z (almost 8 years ago)
- Last Synced: 2025-03-30T08:51:16.254Z (6 months ago)
- Topics: bitbucket-webhooks, git, gitea, github-webhooks, gitlab-webhook, http-server, https-server, json-api, notify, vscode-extension, webhooks
- Language: TypeScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=mkloubert.vscode-git-notify
- Size: 686 KB
- Stars: 11
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# vscode-git-notify
[](https://www.facebook.com/sharer/sharer.php?u=https%3A%2F%2Fmarketplace.visualstudio.com%2Fitems%3FitemName%3Dmkloubert.vscode-git-notify"e=Git%20Notify) [](https://twitter.com/intent/tweet?source=https%3A%2F%2Fmarketplace.visualstudio.com%2Fitems%3FitemName%3Dmkloubert.vscode-git-notify&text=Git%20Notify:%20https%3A%2F%2Fmarketplace.visualstudio.com%2Fitems%3FitemName%3Dmkloubert.vscode-git-notify&via=mjkloubert) [](https://plus.google.com/share?url=https%3A%2F%2Fmarketplace.visualstudio.com%2Fitems%3FitemName%3Dmkloubert.vscode-git-notify) [](http://pinterest.com/pin/create/button/?url=https%3A%2F%2Fmarketplace.visualstudio.com%2Fitems%3FitemName%3Dmkloubert.vscode-git-notify&description=Visual%20Studio%20Code%20extension%2C%20which%20receives%20and%20shows%20git%20events%20from%20webhooks.) [](http://www.reddit.com/submit?url=https%3A%2F%2Fmarketplace.visualstudio.com%2Fitems%3FitemName%3Dmkloubert.vscode-git-notify&title=Git%20Notify) [](http://www.linkedin.com/shareArticle?mini=true&url=https%3A%2F%2Fmarketplace.visualstudio.com%2Fitems%3FitemName%3Dmkloubert.vscode-git-notify&title=Git%20Notify&summary=Visual%20Studio%20Code%20extension%2C%20which%20receives%20and%20shows%20git%20events%20from%20webhooks.&source=https%3A%2F%2Fmarketplace.visualstudio.com%2Fitems%3FitemName%3Dmkloubert.vscode-git-notify) [](http://wordpress.com/press-this.php?u=https%3A%2F%2Fmarketplace.visualstudio.com%2Fitems%3FitemName%3Dmkloubert.vscode-git-notify"e=Git%20Notify&s=Visual%20Studio%20Code%20extension%2C%20which%20receives%20and%20shows%20git%20events%20from%20webhooks.) [](mailto:?subject=Git%20Notify&body=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)
[](https://marketplace.visualstudio.com/items?itemName=mkloubert.vscode-git-notify)
[](https://marketplace.visualstudio.com/items?itemName=mkloubert.vscode-git-notify)
[](https://marketplace.visualstudio.com/items?itemName=mkloubert.vscode-git-notify#review-details)
[Visual Studio Code](https://code.visualstudio.com) extension, which receives and shows git events from webhooks.
## Table of contents
1. [Install](#install-)
2. [How to use](#how-to-use-)
* [Settings](#settings-)
* [Bitbucket](#bitbucket-)
* [GitHub](#github-)
* [Gitea](#gitea-)
* [GitLab](#gitlab-)
* [Secure HTTP](#secure-http-)
3. [Support and contribute](#support-and-contribute-)
## Install [[↑](#table-of-contents)]
Launch VS Code Quick Open (`Ctrl + P`), paste the following command, and press enter:
```bash
ext install vscode-git-notify
```
Or search for things like `vscode-git-notify` in your editor.
## How to use [[↑](#table-of-contents)]
### Settings [[↑](#how-to-use-)]
Open (or create) your `settings.json` in your `.vscode` subfolder of your workspace.
Add a `deploy.reloaded` section and one or more "watchers":
```json
{
"git.notify": {
}
}
```
The following providers and events are supported:
| Event | [Bitbucket](https://bitbucket.org) | [GitHub](https://github.com) | [Gitea](https://gitea.io) | [GitLab](https://gitlab.com)
| ---- |:--:|:--:|:--:|:--:|
| Closed issues | X | X | | X |
| Closed pull requests | X | X | X | X |
| New commit / push | X | X | X | X |
| New issues | X | X | | X |
| New issue comments | X | X | | X |
| New pull requests | X | X | X | X |
| Re-opened issues | X | X | | X |
| Re-opened pull requests | | X | X | X |
#### Bitbucket [[↑](#settings-)]
First you have to create a webhook for your repository.
Click on the `Settings` on the left side, then on `Add webhook` button in `Webhooks`:
Setup 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.
```json
{
"git.notify": {
"watchers": {
"23979": [
{
"provider": "bitbucket"
}
]
}
}
}
```
This will open a HTTP server instance on your machine on port `23979` on startup.
#### GitHub [[↑](#settings-)]
First you have to create a webhook for your repository.
Click on the `Settings` tab and select `Webhooks` on the left side:
Click on `Add webhook` button:
Setup 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.
Now, you can define a watcher in your settings (it is recommended to do this globally - `CTRL + ,` / `CMD + ,`):
```json
{
"git.notify": {
"watchers": {
"80": [
{
"secret": "Test123"
}
]
}
}
}
```
This 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.
#### Gitea [[↑](#settings-)]
First you have to create a webhook for your repository.
Click on the `Settings` tab, select `Webhooks` sub-tab and click on `Add Webhook / Gitea`:
Setup 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.
Now, you can define a watcher in your settings (it is recommended to do this globally - `CTRL + ,` / `CMD + ,`):
```json
{
"git.notify": {
"watchers": {
"8080": [
{
"provider": "gitea",
"secret": "Test123"
}
]
}
}
}
```
This 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.
#### GitLab [[↑](#settings-)]
First you have to create a webhook for your repository.
Click on the `Settings` on the left side and click on `Integrations`:
Setup 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.
```json
{
"git.notify": {
"watchers": {
"5979": [
{
"provider": "gitlab",
"secret": "Test123"
}
]
}
}
}
```
This 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.
#### Secure HTTP [[↑](#settings-)]
It is highly recommended, to setup secure HTTPS instead of plain HTTP:
```json
{
"git.notify": {
"watchers": {
"443": [
{
"secure": true,
"ca": "/path/to/ssl/fullchain.pem",
"cert": "/path/to/ssl/cert.pem",
"key": "/path/to/ssl/privkey.pem",
"secret": "Test 1 2 3"
}
]
}
}
}
```
You can also use relative paths for the SSL files, of course. Those paths are tried to be mapped in the following order:
* `${HOME_DIR}/.ssl`
* `${WORKSPACE}/.vscode` (works also with [multi workspaces](https://code.visualstudio.com/docs/editor/multi-root-workspaces))
If you use a self-signed certificate, you should disable SSL verification in your git provider / hoster.
In GitHub, e.g., you have to click on `Disable SSL verification` button, when adding a web hook:
## Support and contribute [[↑](#table-of-contents)]
If 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).
To contribute, you can [open an issue](https://github.com/mkloubert/vscode-git-notify/issues) and/or fork this repository.
To work with the code:
* clone [this repository](https://github.com/mkloubert/vscode-git-notify)
* create and change to a new branch, like `git checkout -b my_new_feature`
* run `npm install` from your project folder
* open that project folder in Visual Studio Code
* now you can edit and debug there
* commit your changes to your new branch and sync it with your forked GitHub repo
* make a [pull request](https://github.com/mkloubert/vscode-git-notify/pulls)