Skip to main content
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [che-dev] 6.8.0 release notes - request for items
Related to this idea...

If you switch over to the "3 milestones and a Final build" during the 12-week train, rather than "4 Final builds" you can benefit from release note aggregation, like we do for JBoss Tools.

Basically, every sprint when there's something New & Noteworthy (N&N) to blog about, someone writes a short .adoc file, throws it up in jbosstools-website [1] repo, and when we do the Final release, these short N&N snippets are aggregated into a larger N&N for the whole train release.


Here's how that looks for our 4.6.0.Final release [2], aggregating per-sprint updates from AM1, AM2, and AM3* into a single page.


* - If you're wondering why "AM", it's short for "a milestone". Intent was to avoid stating anything about quality. These could be Alpha, Beta, or CR, but that's not guaranteed. We also wanted to differentiate from the way Eclipse release trains do Mx milestones, as they ARE by definition considered Stable releases. Ours are generally good, but again, that's not guaranteed.

Added bonuses to this approach include: 

* travis builds for PRs and pushes
* docker image for building the website locally so you don't have to set up your own ruby/rake environment

The way we enable developers to remember what's N&N is to use labels (tags) in JIRA, so that it's easy at the end of the sprint to query for N&N issues and sue that to create blog/asciidoc content. 


I imagine there's a similar mechanism for tagging and querying in GH Issues, right?

$0.05**,

Nick
 
** - Canada no longer prints pennies, so my "2 cents" rounds up to a nickel now. 

On Thu, Aug 2, 2018 at 11:30 AM Dave Neary <dneary@xxxxxxxxxx> wrote:
Hi everyone,

After discussion with some developers, I'd like to try something new for
the release notes from now on.

We have just hit the end of the 6.8.0 release sprint, and I'd like to
propose that we collaboratively generate the release notes (or, at the
very least, candidate features for inclusion) on the list. I am also
interested in Theia features which will have a high impact for users of
Che who choose to use Theia as the IDE.


There is a release notes template in github:
https://github.com/eclipse/che-docs/blob/master/src/main/pages/release-notes/rn-template.md
which I propose we use to provide a high level outline of work that
happened in the last release which delivers something which is impactful
to users (may be the last piece of a puzzle started in previous sprints).


Please reply to this with the following information if there is
something you would like to see featured in the release notes (and,
since I am soon going on vacation, please reply to the list):

- Feature name/label
- Quick description of value/impact for Che users
- One paragraph description of how to access/use feature
- Links to PRs which implemented this feature (or made it available to
users)
- Key contributors to the feature

If feasible, please attach an image or animated GIF showing the feature
in action.


For smaller, but nevertheless important, features or high impact bug
fixes, a single line describing the impact and a link to the PR and/or
issue would be great also.


This is a new process, I'm sure we'll be ironing out kinks for the next
few releases, but the goal of this process is to increase transparency
in how we produce release note blogs, to ensure we give credit where
due, and hopefully to spread the load of producing release notes so that
we can have a more regular flow of information about the work we are
doing to the user community and beyond.

Thank you all for your support!

Dave.

--
Dave Neary - Open Source and Standards team
Red Hat - http://community.redhat.com
Ph: +1-978-399-2182 / Cell: +1-978-799-3338
_______________________________________________
che-dev mailing list
che-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://dev.eclipse.org/mailman/listinfo/che-dev


--

Nick Boldt

Principal Software Engineer, RHCSA

Productization Lead :: JBoss Tools & Dev Studio

IM: @nickboldt / @nboldt / http://nick.divbyzero.com



“The Only Thing That Is Constant Is Change” - Heraclitus

Back to the top