RFC: Enhancing DCS Dropzone Mod Manager with a Manual & Automated Registry Update System

[JonathanTurnock]

1. Introduction

Background

DCS Dropzone is a community mod manager for DCS World, designed to streamline the process of managing and updating mods. The mod manager currently operates by fetching mod lists from a registry - a collection of JSON files hosted on Cloudflare Pages. These JSON files point to various GitHub repositories containing the mods. The desktop application of DCS Dropzone interacts directly with the GitHub Releases API to obtain the latest release information.

Purpose

The purpose of this RFC is to propose a system enhancement for DCS Dropzone. The enhancement aims to automate the update process of the registry and provide a more flexible and inclusive mechanism for mod authors, especially those not using GitHub.

2. Proposal

Overview

The primary change involves shifting the responsibility of updating mod information from the user's desktop application to the registry itself. This change will enable the registry to hold all necessary data for the app to function, reducing direct dependency on GitHub's API.

For GitHub Users

• Implement a system where mod authors using GitHub can set up a webhook.
• This webhook will be triggered upon new releases.
• A Cloudflare Worker will respond to this webhook, automatically updating the registry with the latest release information.

For Non-GitHub Users

• Allow manual maintenance of the registry.
• Introduce support for other platforms like GitLab or DCS user files.
• Provide an option for manual webhook triggers to update the registry.

3. Advantages

• Reduces Dependency on GitHub: This system minimizes the direct reliance on GitHub, allowing for broader inclusivity of mod authors using different platforms.
• Automates Updates: Automating the update process saves time and reduces errors in the mod update process.
• Flexibility: Offers a flexible solution for both GitHub and non-GitHub users.
• Enhanced User Experience: Streamlines the user experience by ensuring the mod manager always has up-to-date information.

[JonathanTurnock]

[john681611]

Ah I was under the impression we could subscribe to repos ourselves. But still looks good.

Alternative: What about hooking into a GitHub user notifications https://docs.github.com/en/rest/activity/notifications?apiVersion=2022-11-28#list-notifications-for-the-authenticated-user I can't find docs but I wonder if it's possible to watch only the repository releases. Then we just poll the notifications every hour or so and pickup releases.

[JonathanTurnock]

I think its not to much to ask for people to use a webhook right, then if there are other pathways it should be pretty easy.

I've created a branch with the changes to get a feel for them and also added a README that instructs how this would work.

https://github.com/flying-dice/dcs-mod-manager-registry/tree/develop

The TLDR is that they send a GH Release event, which I think contains the repo info.

We give them a signed JWT which contains the folder and that way no funny business should occur with people writing to folders they have no business in.