cheatcode / joystick

A full-stack JavaScript framework for building stable, easy-to-maintain apps and websites.
https://cheatcode.co/joystick
Other
209 stars 11 forks source link

Add a /releases folder to each package with timestamped release files written in JSON #312

Closed rglover closed 2 months ago

rglover commented 1 year ago

This would be rad. I have a terrible memory for things like release notes/announcements and it'd be helpful if there was a convention built in.

The idea is to have a folder structure like this for each package:

/releases
-- 2023-08-24.json
-- 2023-08-18.json

In each JSON file you'd have something like:

[{
  "package": "@joystick.js/node",
  "version": "1.1.0",
  "description": "A general description for the release",
  "changes": [
     { "change": "Description of the change...", "example": "Example code if applicable..." }
  ],
}]

Each JSON file would return an array in case we have multiple releases in one day (e.g., emergency patches or just a productive day).

On the site, we could have a CRON job that checked for changes on some interval (e.g., 1 per hour, 1 per day) and it would grab the releases, update the DB, and then send a notification to stuff like Discord, Twitter, and an email list.