On 7 December 2017 at 20:26, Dirk Hohndel <d...@hohndel.org> wrote:
>
>> On Dec 7, 2017, at 12:09, Lubomir I. Ivanov <neolit...@gmail.com> wrote:
>>> I need to write a release announcement. I haven’t had enough time this 
>>> morning to look into this - I’ve been fighting with screen shots for the 
>>> iOS app for two hours. What fun.
>>>
>>>> isn't what's in our CHANGELOG.md sufficient? i know about at least a
>>>> couple of changes that were not mentioned there.
>>>
>>> That’s part of it - make sure all relevant changes are mentioned.
>>
>> ok, i will now go through the commits and see what is missing and add
>> it. question about RleaseNotes.txt format bellow.
>> we should require PRs to always add notes to CHANGELOG.md before
>> accepting the PR.
>
> Yes, we should.
>
>>> Sort them for what’s relevant to mobile vs desktop
>>> And then... do we want to collate them back into ReleaseNotes.txt when we 
>>> do a release?
>>>
>>
>> i'm not sure TBH. i would move what has accumulated in CHANGELOG.md to
>> ReleaseNotes.txt.
>> normally projects only have a CHENGELOG.md file, but we are using
>> asciidoc/a2x for the .txt.
>>
>> so in our case we need an extra step.
>>
>> i think the formatting of ReleaseNotes.txt has to be changed from:
>> "Some of the changes since _Subsurface_ 4.7.4"
>> ...
>>
>> to (the old format):
>> "New in version 4.7.5" / : "Changes in 4.7.5"
>> ...
>
> Oh, good. I like that (says the person who started what’s now in 
> ReleaseNotes.txt)
>

i went through the commits and this is what i ended up with - attached patch.

    - Minor formatting changes (to the release notes lines - e.g.
consistent "Subsurface-mobile:")
    - Added a couple of missing notes
    - Make the ReleaseNotes.txt format to indicate the latest
    version on top

Here is a quick write up based on the previous one:

----------------------------------------------------
Announcing Subsurface 4.7.5

This version of Subsurface makes a set of improvements in the
Bluetooth integration, the planner, the map widget and the dive photo
user interface.

Some of the changes in Subsurface 4.7.5:

- Compute plan variations in background to improve responsiveness
- Improve profile rescaling in planner
- Store the gas switch depth of a cylinder from the planner in the logbook
  file or git storage. No more need to reenter this value on replanning.
- Improved handling of different information (divemaster, buddy, suit, notes)
  when merging two dives.
- Limit min. GFlow to 10 and min. GFhigh to 40 in preferences for profile
  and planner
- Fix issues related to debug logging on Windows
- Add "Bluetooth mode" in the BT selection dialog: Auto, LE, Classical
- Correct display of cylinder pressures for merged dives
- Allow user defined cylinders as default in preferences
- Tag-editing: comma entry shows all tags (again)
- Printing: the bundled templates are now read-only and are always overwritten
  by the application. The first time the user runs this update, backup files
  of the previous templates would be created
- Fix issues with filters not updating after changes to the dive list
- Map-widget: allow updating coordinates on the map when the user
  is editing a dive site by pressing Enter or clicking a "flag" button
- Map-widget: prevent glitches when the user is interacting with the map
  while animations are in progress
- Planner: don't accidentally enable o2breaks option when entering planner in
  recreational mode
- Various small improvements in the dive photo UI

Binaries are available for Windows, Mac, and an AppImage for x86-64 Linux.
Distribution specific binaries for a number of Linux flavors including
<list ?> are available too.

----------------------------------------------------


^ i would also add this:

----------------------------------------------------
Our build system now supports a continuous build which allows you to
run the latest development version for testing purposes:
https://github.com/Subsurface-divelog/subsurface/releases/tag/continuous
NOTE: Could be unstable, use at your own risk!
----------------------------------------------------

>> understood - that's what i said last time, but still merged things. ugh.
>> perhaps "the merge window is now closed" notification would make it
>> more clear to everyone.
>
> But we don’t have a formal merge window, and we don’t have a process
> where we do RCs after the merge window. All I’m hoping for is a bit of
> stability / quiet in the repo while I’m literally trying to get to a release.
> And of course, I myself am the worst offender...
>
>> one problem he have is that not all collaborators review and small PRs
>> tend to collect dust.
>
> Everyone here volunteers whatever time they are comfortable with.
> I try to comment on every PR within a day or two. I’d love it if others
> did more, but I’m grateful for what everyone is able to contribute.
>
>> always a couple of people reviewing a PR, one being a maintainer is of
>> course the ideal scenario, but we only have that something like 30% of
>> the time.
>>
>> maybe we should always wait for a couple of people approving a PR.
>
> This is why I hate black and white rules.
> Many cleanups are obviously correct (removing an unused variable as
> an extreme case). Why would that wait for a review?
> On the flip side, especially things that change the UI, change core data
> structures... those really should get a review or two.
>

maybe in time the rules and formal rules will establish them self -
i.e. "learn as we go".
yes, the "always 2 people reviewing" scenario is ideal, but overkill
for all commits.

lubomir
--
From 6533e7a3a09bd24946a154e9b497f7181c2e062f Mon Sep 17 00:00:00 2001
From: "Lubomir I. Ivanov" <neolit...@gmail.com>
Date: Thu, 7 Dec 2017 20:39:11 +0200
Subject: [PATCH] ReleaseNotes.txt: apply CHANGELOG.md

- Minor formatting changes
- Added a couple of missing notes
- Make the ReleaseNotes.txt format to indicate the latest
version on top

Signed-off-by: Lubomir I. Ivanov <neolit...@gmail.com>
---
 CHANGELOG.md                  | 26 --------------------------
 ReleaseNotes/ReleaseNotes.txt | 37 ++++++++++++++++++++++++++++++++++++-
 2 files changed, 36 insertions(+), 27 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index a80004e54..e69de29bb 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,26 +0,0 @@
-- Subsurface-mobile: Add button to recan for BT devices
-- Subsurface-mobile: Enable BLE and GPS on iOS
-- Compute plan variations in background to improve responsiveness
-- Improve profile rescaling in planner
-- Store the gas switch depth of a cylinder from the planner in the logbook
-  file or git storage. No more need to reenter this value on replanning.
-- Improved handling of different information (divemaster, buddy, suit, notes)
-  when merging two dives.
-- Limit min. GFlow to 10 and min. GFhigh to 40 in preferences for profile
-  and planner
-- Fix issues related to debug logging on Windows
-- Add "Bluetooth mode" in the BT selection dialog: Auto, LE, Classical
-- Correct display of cylinder pressures for merged dives
-- Allow user defined cylinders as default in preferences (#821)
-- mobile: fix black/white switch in splash screen (#531)
-- UI: tag editing. Comma entry shows all tags (again) (#605)
-- mobile: enable auto completion for dive site entry (#546)
-- Printing: the bundled templates are now read-only and are always overwritten
-  by the application. The first time the user runs this update, backup files
-  of the previous templates would be created (#847)
-- Fix issues with filters not updating after changes to the dive list
-  (#551, #675)
-- map-widget: allow updating coordinates on the map when the user
-  is editing a dive site by pressing Enter or clicking a "flag" button
-- map-widget: prevent glitches when the user is interacting with the map
-  while animations are in progress
diff --git a/ReleaseNotes/ReleaseNotes.txt b/ReleaseNotes/ReleaseNotes.txt
index 9c55f720b..96a05f0ef 100644
--- a/ReleaseNotes/ReleaseNotes.txt
+++ b/ReleaseNotes/ReleaseNotes.txt
@@ -2,9 +2,44 @@ Please add release notes on top of the file /CHANGELOG.md
 
 // _Subsurface_ 4.7.5 Release Notes
 
-_Subsurface_ 4.7.5 - Month dd, 2017
+_Subsurface_ 4.7.6 - Month dd, 2017
 ------------------------------------------
 
+
+_Subsurface_ 4.7.5:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- Subsurface-mobile: Add button to rescan for BT devices
+- Subsurface-mobile: Enable BLE and GPS on iOS
+- Compute plan variations in background to improve responsiveness
+- Improve profile rescaling in planner
+- Store the gas switch depth of a cylinder from the planner in the logbook
+  file or git storage. No more need to reenter this value on replanning.
+- Improved handling of different information (divemaster, buddy, suit, notes)
+  when merging two dives.
+- Limit min. GFlow to 10 and min. GFhigh to 40 in preferences for profile
+  and planner
+- Fix issues related to debug logging on Windows
+- Add "Bluetooth mode" in the BT selection dialog: Auto, LE, Classical
+- Correct display of cylinder pressures for merged dives
+- Allow user defined cylinders as default in preferences (#821)
+- Subsurface-mobile: fix black/white switch in splash screen (#531)
+- Tag-editing: comma entry shows all tags (again) (#605)
+- Subsurface-mobile: enable auto completion for dive site entry (#546)
+- Printing: the bundled templates are now read-only and are always overwritten
+  by the application. The first time the user runs this update, backup files
+  of the previous templates would be created (#847)
+- Fix issues with filters not updating after changes to the dive list
+  (#551, #675)
+- Map-widget: allow updating coordinates on the map when the user
+  is editing a dive site by pressing Enter or clicking a "flag" button
+- Map-widget: prevent glitches when the user is interacting with the map
+  while animations are in progress
+- Planner: don't accidentally enable o2breaks option when entering planner in
+  recreational mode
+- Various small improvements in the dive photo UI
+
+
 Some of the changes since _Subsurface_ 4.7.2
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-- 
2.15.0.windows.1

_______________________________________________
subsurface mailing list
subsurface@subsurface-divelog.org
http://lists.subsurface-divelog.org/cgi-bin/mailman/listinfo/subsurface

Reply via email to