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

Add release notes in Markdown format #404

Merged
merged 1 commit into from Nov 11, 2019

Conversation

@mloskot
Copy link
Member

mloskot commented Nov 11, 2019

Description

This proposes to use Git to maintain notes about all notable changes to GIL in RELEASES.md file based on https://keepachangelog.com format.

Collect all past release notes.
Collect release notes for the pending Boost 1.72.0, to be released in December according to Boost release schedule.

IMPORTANT: Before Boost release is issued, our release notes from RELEASES.md should be copied and added to relevant file in https://github.com/boostorg/website/tree/master/feed/history

References

This implements proposal discussed and agreed in the thread https://lists.boost.org/boost-gil/2019/11/0336.php

Tasklist

  • Review and approve

It is possible to integrate the release notes into Sphinx-generated documentation. It will be implemented as soon as this proposal is merged.

@mloskot mloskot added the cat/feature label Nov 11, 2019
@mloskot mloskot added this to the Boost 1.72 milestone Nov 11, 2019
@mloskot mloskot requested a review from stefanseefeld Nov 11, 2019
@mloskot mloskot self-assigned this Nov 11, 2019
Copy link
Member

stefanseefeld left a comment

Wow, you put a lot of effort into this ! It's a lot of detail.
One minor point: you mark the recent changes as "unreleased", yet you are working on this in preparation for 1.72. Do you expect a separate PR (or commit) to turn "unreleased" into "1.72" ? Can't these two change sets be combined ?

This proposes to use Git to maintain notes about all notable changes to
GIL in `RELEASES.md` file based on https://keepachangelog.com format.
This implements proposal discussed and agreed in the thread
https://lists.boost.org/boost-gil/2019/11/0336.php

Collect all past release notes.
Collect release notes for the pending Boost 1.72.0, in section [Unreleased].
@mloskot mloskot force-pushed the mloskot:ml/release-notes-in-markdown branch from 21d6976 to 649c64c Nov 11, 2019
@mloskot

This comment has been minimized.

Copy link
Member Author

mloskot commented Nov 11, 2019

@stefanseefeld This is a good point. I have updated this PR adding the missing version and date (based on what's in Boost calendar).

Copy link
Member

stefanseefeld left a comment

Many thanks for working on this.

@mloskot mloskot merged commit c24e8b2 into boostorg:develop Nov 11, 2019
7 checks passed
7 checks passed
boostorg.gil Build #20191111.2 succeeded
Details
boostorg.gil (macos1013_xcode91_cmake) macos1013_xcode91_cmake succeeded
Details
boostorg.gil (ubuntu1604_gcc5_cxx11_cmake) ubuntu1604_gcc5_cxx11_cmake succeeded
Details
boostorg.gil (ubuntu1604_gcc8_cxx14_cmake) ubuntu1604_gcc8_cxx14_cmake succeeded
Details
boostorg.gil (win2012_vs2015_cmake) win2012_vs2015_cmake succeeded
Details
boostorg.gil (win2016_vs2017_cxx14_cmake) win2016_vs2017_cxx14_cmake succeeded
Details
boostorg.gil (win2016_vs2017_cxx17_cmake) win2016_vs2017_cxx17_cmake succeeded
Details
@mloskot mloskot deleted the mloskot:ml/release-notes-in-markdown branch Nov 11, 2019
mloskot added a commit that referenced this pull request Nov 23, 2019
* develop:
  Update Boost 1.72.0 release notes with PR #403
  Mention C++11 in meta/libraries.json
  Add release notes in Markdown format (#404)
  Typo in README
  Remove include/boost/gil/version.hpp file as unused (#403)
  Add Markdown linting with Node package markdownlint
  doc/README.md: clarify steps building docs
  CONTRIBUTING.md: Remove logo as unnecessary
  README.md: Fix FreeNode link and hash escape
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.