Skip to content

Latest commit

 

History

History
61 lines (48 loc) · 2.37 KB

architecture.md

File metadata and controls

61 lines (48 loc) · 2.37 KB
Raw

Architecture

Overview

The project is a Node.js application that uses the Probot framework to listen for events from GitHub. It uses a GitHub App to perform elevated actions on behalf of the user while the user has little or no permissions at all.

EMU Flow

sequenceDiagram
    participant U as upstream *Public
    box github.com/public-organization
        participant F as fork *Public
    end
    box github.com/emu-organization
        participant M as mirror *Private
    end
    U->>F: User forks upstream into Organization
    F-->>F: Bot creates branch protection rules
    F-->>F: User requests mirror to be made
    F->>M: Bot creates a mirror of the fork
    M-->>M: Bot creates branch protection rules
    M-->>M: User makes all changes in non-default branches
    M-->>M: User merges into `default` branch
    M->>F: Bot automatically syncs mirror to fork
    F->>U: User opens PR to upstream
Loading

Single Organization Flow

sequenceDiagram
    participant U as upstream *Public
    box github.com/your-public-organization
        participant F as fork *Public
        participant M as mirror *Private
    end
    U->>F: User forks upstream into Organization
    F-->>F: Bot creates branch protection rules
    F-->>F: User requests mirror to be made
    F->>M: Bot creates a mirror of the fork
    M-->>M: Bot creates branch protection rules
    M-->>M: User makes all changes in non-default branches
    M-->>M: User merges into `default` branch
    M->>F: Bot automatically syncs mirror to fork
    F->>U: User opens PR to upstream
Loading

Components

UI

The UI is built in nextjs with React Typescript. The main purpose of the UI is to provide a way for the user to request a mirror repository to be created. Every other part of the workflow can be achieved in GitHub or with the git CLI.

GitHub App

The GitHub App is the main component of the project. It is responsible for listening to events from GitHub and performing actions on behalf of the user. It is also responsible for creating the mirror repository and syncing all changes between the fork and the mirror.

Node Server

As part of the nextjs framework, it exposes a Node server we can use to run the GitHub App. This is the entry point for the application. It is responsible for loading the GitHub App and starting the server as well as performing git operations.