On Tue, Nov 10, 2020 at 3:37 AM Sean Busbey <bus...@apache.org> wrote:

> We've talked for some time about possibly including release notes / changes
> for just those things in each individual release on the website before.
> Would adding something like that be sufficient for the use you're thinking
> of?
>

Having a page on the site dedicated to this would suit my needs, but maybe
it's overkill if we can just "get it right" for the release tags visible on
github. My objective is giving a user-friendly and self-service answer to
an operator or developer asking, "why should I upgrade? / what's new in
this release?" The existing CHANGES.md file on the release tag would work,
except that the markdown doesn't render on Github due to size.

On Mon, Nov 9, 2020, 15:35 Nick Dimiduk <ndimi...@apache.org> wrote:
>
> > Heya,
> >
> > The CHANGES.md file on branch-2.3 weighs in at over 1mb and is too big
> for
> > Github to render. Its content covers back to 0.99. This isn't really
> usable
> > by someone who wants to easily see what's new in the latest patch
> release.
> >
> > I propose we truncate these changes files to what's new for the release
> > branch. It probably needs some more work, but the git-jira audit script
> [0]
> > is able to generate a report of what's new (never previously released)
> for
> > a target release-line branch. We could use this as the basis for the
> > CHANGES file when starting a new release-line branch. From then on, Yetus
> > takes care of the patch release updates.
> >
> > What do you think?
> >
> > Thanks,
> > Nick
> >
> > [0]:
> >
> >
> https://github.com/apache/hbase/tree/master/dev-support/git-jira-release-audit
> >
>

Reply via email to