search

twitter / storehaus

Storehaus is a library that makes it easy to work with asynchronous key value stores
Apache License 2.0
464 stars 86 forks source link

consider managing release notes with herald #107

Open softprops opened 11 years ago

softprops commented 11 years ago

A colleague and myself curate a tumblr account for announcing release notes for scala projects using herald as the primary client. The recipe is simple, you drop a file named {version}.markdown in a notes directory under your source tree. Just run herald in your the directory containing the notes dir and herald will figure out the latest release and generate a preview and post to notes. This has been a great way for me to keep trace of what changes in my projects and document it for my users in a common location. Would this be something storehaus would be interested in doing? If you guys can pass along an email associated with a tumblr account. I can get you up and running.

sritchie commented 11 years ago

Hey, this sounds excellent. We probably need a custom email for this project, right? Do you just want me to create a placeholder twitter account?

softprops commented 11 years ago

Nah, its basically needed to add you, or whoever wants to publish notes, to the list of people that can publish to notes.implicit.ly. Basically the way posting works is we load up a preview in the browser, and when you're ready to post, you oauth with tumblr and herald publishes it to notes.implicit.ly

softprops commented 11 years ago

Well, I guess you could sign up for a fake tumblr account with a twitter address. The person posting would need to know the password associated with that email on tumblr.

sritchie commented 11 years ago

Ah, gotcha. I'm at sritchie09@gmail.com. You've been inspiring me to go on a documentation binge... I'll start posting the fruits of my labors soon.

softprops commented 11 years ago

You should receive and invite from tumblr shortly

sritchie commented 11 years ago

Looks great, I'm game for trying this out.

I made a couple of release tags -- https://github.com/twitter/storehaus/issues/milestones?with_issues=no

I think we should plan for another release and do this when we ship the code. What do you guys want to see in the next release? I think the reshuffle and extra bijection dep should occur in 0.4.0, of course, so let's get minor issues covered before then.

doug tangren mailto:notifications@github.com May 8, 2013 1:39 PM

You should receive and invite from tumblr shortly

— Reply to this email directly or view it on GitHub https://github.com/twitter/storehaus/issues/107#issuecomment-17632290.

doug tangren mailto:notifications@github.com May 7, 2013 4:01 PM

A colleague and myself curate a tumblr account http://notes.implicit.ly/ for announcing release notes for scala projects using herald https://github.com/n8han/herald#herald as the primary client. The recipe is simple, you drop a file named {version}.markdown in a |notes| directory under your source tree. Just run |herald| in your the directory containing the |notes| dir and herald will figure out the latest release and generate a preview and post to notes. This has been a great way for me to keep trace of what changes in my projects and document it for my users in a common location. Would this be something storehaus would be interested in doing? If you guys can pass along an email associated with a tumblr account. I can get you up and running.

— Reply to this email directly or view it on GitHub https://github.com/twitter/storehaus/issues/107.

Sam Ritchie, Twitter Inc 703.662.1337 @sritchie

softprops commented 11 years ago

Sure. The bijection stuff on my branch did'nt remove code, just deprecated it. It should be good for a pull request maybe tonight but I want to test some things first. I cleaned out all the internal deprecation warnings last night

sritchie commented 11 years ago

Nice, love it.