Add release notes in Markdown format #404
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
stefanseefeld
reviewed
Nov 11, 2019
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
force-pushed
the
ml/release-notes-in-markdown
branch
from
21d6976
to
649c64c
Compare
|
@stefanseefeld This is a good point. I have updated this PR adding the missing version and date (based on what's in Boost calendar). |
mloskot
added a commit
that referenced
this issue
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Description
This proposes to use Git to maintain notes about all notable changes to GIL in
RELEASES.mdfile 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.
References
This implements proposal discussed and agreed in the thread https://lists.boost.org/boost-gil/2019/11/0336.php
Tasklist
It is possible to integrate the release notes into Sphinx-generated documentation. It will be implemented as soon as this proposal is merged.