https://github.com/rustyx/google-cloud-build-notifier
(A better) Google Cloud Build GitHub notifier
https://github.com/rustyx/google-cloud-build-notifier
Last synced: about 1 year ago
JSON representation
(A better) Google Cloud Build GitHub notifier
- Host: GitHub
- URL: https://github.com/rustyx/google-cloud-build-notifier
- Owner: rustyx
- License: mit
- Created: 2019-11-21T10:51:51.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-01-09T08:39:03.000Z (over 2 years ago)
- Last Synced: 2025-01-24T14:38:54.134Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 242 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Google Cloud Build GitHub notifier
This is a simple Google Cloud Function that notifies GitHub of Cloud Build outcomes.
It is useful as an alternative for the official Google Cloud Build app, as it does not attempt to manage Google Cloud builds and instead relies on *existing* Google Cloud builds, so that their full potential, such as custom triggering, can be exploited.
## Installation
1. Go to your **GitHub Organization Settings** -> Developer Options -> GitHub Apps
2. Create a new **GitHub App**:
* Name: `Google Cloud Build`
* Homepage URL: `https://console.cloud.google.com/cloud-build/builds`
* User authorization callback URL: `https://console.cloud.google.com/cloud-build/builds`
* Webhook URL: `https://europe-west1-au-prod.cloudfunctions.net/gh-webhook`
* Permissions: **Checks** - read & write, **Commit statuses** - read & write
3. Generate a new private key
4. Install the newly added GitHub App in your GitHub organization
5. Fill in `APP_ID` and `APP_PRIVATE_KEY` details in `index.js`
6. Go to **Google Cloud Console** -> [Functions](https://console.cloud.google.com/functions)
7. Create a new Cloud Function:
* Trigger: Cloud Pub/Sub,
* Topic: cloud-builds,
* Runtime: Node 10,
* Copy/paste `index.js` and `package.json` contents into the relevant text fields,
* Function to execute: `handleEvent`,
* Advanced -> select region (optional)
## Known issues / limitations
- The webhook URL is mandatory, but is not supported; the webhook URL mentioned above does nothing
- The GitHub "*re-run build*" button does not work as there is no webhook support yet