Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create releases #17

Open
ngerakines opened this issue Oct 31, 2024 · 2 comments
Open

Create releases #17

ngerakines opened this issue Oct 31, 2024 · 2 comments

Comments

@ngerakines
Copy link

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:

  • Migrate the project to a formal tag-and-release cycle where people can see what the latest deployed changes are and subscribe to updates.
  • Allow the zstd_dictionary to be moved out of the repository and attached to releases as blob attachments
  • Move downloading release content (builds and artifacts like the zstd_dictionary) onto the releases CDN and out of git
@ericvolp12
Copy link
Collaborator

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
Copy link

uniphil commented Nov 4, 2024

it would be nice to have a quick place to find about breaking changes like #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.

git log --pretty=format:'- %s (%ae)' $(git describe --tags --abbrev=0)..

just as example

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants