bluesky-social / jetstream

A simplified JSON event stream for AT Proto
MIT License
128 stars 11 forks source link

Create releases #17

Open ngerakines opened 2 weeks ago

ngerakines commented 2 weeks ago

This is a feature request to improve developer experience.

GitHub releases would be a great place to have change log information, as well as zstd dictionaries. Using them would accomplish a couple of things:

ericvolp12 commented 2 weeks ago

TBH I've never really maintained a project using that formal of a flow and I'm not totally sure what the process for doing releases is there. I don't anticipate there being a ton of change momentum on this project soon considering it's a pretty simple interface but I do see the appeal of having some form of versioning.

uniphil commented 1 week ago

it would be nice to have a quick place to find about breaking changes like https://github.com/bluesky-social/jetstream/pull/7 when i only notice my thing isn't working a few days later :) (realizing this is only a problem for me because i'm relying on the free public hosted instances, not complaining)

if you are thinking of adopting something this way, github does a few nice things automatically if you make tags and connect them to their "releases" through the web UI. Or, a classic changelog file avoids github lock-in for a bit of manual (and/or scripted*) work.

*git log changes since last tag i use this on a few projects to generate changelogs, but usually manually edit emails to github ids and sometimes linking PRs before committing. there are probably better ways. ```sh git log --pretty=format:'- %s (%ae)' $(git describe --tags --abbrev=0).. ``` just as example