From 0a0c7dd8c7ebcf5f42b77a6d438097a89d8e9e7c Mon Sep 17 00:00:00 2001 From: Johannes Schindelin Date: Thu, 17 Aug 2023 12:42:34 +0200 Subject: [PATCH] docs: mention where to find the code for the GitHub App The code was moved to https://github.com/gitgitgadget/gitgitgadget-github-app and we will want contributors to still find it ;-) Signed-off-by: Johannes Schindelin --- CONTRIBUTING.md | 2 ++ DESIGN.md | 3 ++- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8fed6afb76..7ea3b6fa5f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,6 +21,8 @@ The most important part of the source code lives in `lib/`, and is written in Ty The exception to that rule are scripts, such as `ci-helper.ts` which backs the Azure Pipeline that is implicitly triggered via the GitHub App, which live in `scripts/`. +Speaking of the GitHub App: It is implemented in a serverless fashion, as an Azure Function that gets called via webhook events, and the code backing that Azure Function lives in https://github.com/gitgitgadget/gitgitgadget-github-app. Its job is to perform very light validation of the payload and to trigger the appropriate Azure Pipeline upon receiving valid slash commands. + The tests to verify that everything works as expected live in `tests/`, and use the [Jest](https://facebook.github.io/jest/) framework. Please make sure to add tests for whatever functionality you add when developing a new feature, to gain confidence that your feature or bug fix will work also in the future. If you never developed any node.js or Typescript project: you will need to get the dependencies via `npm install`, and you will want to run the tests via `npm run test`. diff --git a/DESIGN.md b/DESIGN.md index 484df1d86d..de80631b1d 100644 --- a/DESIGN.md +++ b/DESIGN.md @@ -79,7 +79,8 @@ GitHub App and triggers an Azure Pipeline when given specific commands. ### Typescript A convenient way to implement a UI based on GitHub Pull Requests is to create -a GitHub App that triggers an Azure Function that is implemented in Javascript. +a GitHub App that triggers [an Azure Function that is implemented in +Javascript](https://github.com/gitgitgadget/gitgitgadget-github-app). The backend is implemented as an Azure Pipeline, using Typescript to allow for type-safe and convenient development, and [Visual Studio