Release notes for v0.19

Here's the place for discussion related to coding in FreeCAD, C++ or Python. Design, interfaces and structures.
User avatar
Joel_graff
Posts: 1446
Joined: Fri Apr 28, 2017 4:23 pm
Contact:

Release notes for v0.19

Postby Joel_graff » Sat Mar 02, 2019 1:53 pm

Having spent a couple hours going over things, I have data wrangling from git log and mantis pretty well figured out.

The big issue is correlating the two. For example, in some of the closed issues in Mantis, there's a related changeset note which includes the first few characters of the git commit hash - that's easy to correlate. In other cases, there might be a link to the commit in the notes... which I can extract. However, I suspect that there's a number of mantis items which are not associated with a git commit.

So I see automating the process of release notes to be rather challenging without some quality control on the data moving forward. I'm going to assume that it would be preferable to use Mantis as the front-end for summarizing the commit history - otherwise, git commits need individual tagging, which, I'm sure, is not at all a desirable change to have to make.

Anyway, I understand developing the release notes is a bit of a manual job - I don't expect to do it entirely by script - but, of course, the more I can automate, the better.

That said, what, exactly, would be desirable in a release notes document? Are we talking about just a very brief summary of Mantis items and their immediate git commits? Or something more extensive including related commit history? I'm assuming it would be desirable to have something more than just a raw list of roughly-categorized git commits since the previous release...

Incidentally, I'm a bit overwhelmed trying to sort this out as well as develop release notes for 0.18. I don't mind giving it a shot, but I wouldn't mind a little assistance. :)
You can find the FreeCAD Trails workbench for transportation engineering on my github at:
https://www.github.com/joelgraff/freecad.trails
User avatar
Kunda1
Posts: 5081
Joined: Thu Jan 05, 2017 9:03 pm

Re: Release notes for v0.19

Postby Kunda1 » Sat Mar 02, 2019 10:35 pm

I bet it would help, to some degree, if the source integration plugin actually worked: issue #3244
Because potentially we could get all commits associated with a ticket through mantis.
Want to contribute back to FC? Checkout:
#lowhangingfruit | Use the Source, Luke. | How to Help FreeCAD | How to report FC bugs and features
User avatar
Joel_graff
Posts: 1446
Joined: Fri Apr 28, 2017 4:23 pm
Contact:

Re: Release notes for v0.19

Postby Joel_graff » Sat Mar 02, 2019 10:43 pm

Kunda1 wrote:
Sat Mar 02, 2019 10:35 pm
I bet it would help, to some degree, if the source integration plugin actually worked: issue #3244
Because potentially we could get all commits associated with a ticket through mantis.
Gee. That would be nice. Way outta my league, though. Once we get past release, maybe Kurt can take a little longer look at it? If nothing else, I can correlate the two, so long as the github commit is referenced in the mantis ticket.
You can find the FreeCAD Trails workbench for transportation engineering on my github at:
https://www.github.com/joelgraff/freecad.trails
triplus
Posts: 8605
Joined: Mon Dec 12, 2011 4:45 pm

Re: Release notes for v0.19

Postby triplus » Sun Mar 03, 2019 12:06 pm

TechDraw:
  • Improved scale support for added viewport geometry as an image to a drawing.
Image

Forum thread
triplus
Posts: 8605
Joined: Mon Dec 12, 2011 4:45 pm

Re: Release notes for v0.19

Postby triplus » Sun Mar 03, 2019 12:17 pm

Draft:
  • Direct node editing tool.
Image

Forum thread
User avatar
Joel_graff
Posts: 1446
Joined: Fri Apr 28, 2017 4:23 pm
Contact:

Re: Release notes for v0.19

Postby Joel_graff » Sun Mar 03, 2019 12:57 pm

triplus wrote:
Sun Mar 03, 2019 12:17 pm
Draft:

Direct node editing tool.
Updated both features. :) Definitely room for a little improvement once I get used to wiki editing.

https://www.freecadweb.org/wiki/Release_notes_0.19
Last edited by Joel_graff on Tue Mar 05, 2019 1:48 am, edited 1 time in total.
You can find the FreeCAD Trails workbench for transportation engineering on my github at:
https://www.github.com/joelgraff/freecad.trails
triplus
Posts: 8605
Joined: Mon Dec 12, 2011 4:45 pm

Re: Release notes for v0.19

Postby triplus » Sun Mar 03, 2019 1:45 pm

Joel_graff wrote:
Sun Mar 03, 2019 12:57 pm
Updated both features. :) Definitely room for a little improvement once I get used to wiki editing.
Great!

P.S. For sure, over the year and based on other people feedback, suggestions and contributions, things can always be improved. Hopefully some people interested in making videos will tag along. As good release notes video is something that usually makes sesne.
User avatar
Joel_graff
Posts: 1446
Joined: Fri Apr 28, 2017 4:23 pm
Contact:

Re: Release notes for v0.19

Postby Joel_graff » Mon Mar 04, 2019 10:57 pm

triplus wrote:
Sun Mar 03, 2019 1:45 pm
Great!

P.S. For sure, over the year and based on other people feedback, suggestions and contributions, things can always be improved. Hopefully some people interested in making videos will tag along. As good release notes video is something that usually makes ses
Do we want to include other items as well? A general summary of bug fixes?

Maybe highlight some of the new external workbenches that are being developed (assuming the development continues)? There's an electromagnetic wb, a lithoplanes wb, and HakanSeven showed up and started developing a geomatics (land surveying) wb...
You can find the FreeCAD Trails workbench for transportation engineering on my github at:
https://www.github.com/joelgraff/freecad.trails
triplus
Posts: 8605
Joined: Mon Dec 12, 2011 4:45 pm

Re: Release notes for v0.19

Postby triplus » Mon Mar 04, 2019 11:45 pm

Joel_graff wrote:
Mon Mar 04, 2019 10:57 pm
Do we want to include other items as well? A general summary of bug fixes?
There could be a (module specific) paragraph dedicated to that. That is if some understanding can be established and to put it together in some sensible way. It shouldn't get too technical, as release notes are more or less intended for general public.
Maybe highlight some of the new external workbenches that are being developed (assuming the development continues)? There's an electromagnetic wb, a lithoplanes wb, and HakanSeven showed up and started developing a geomatics (land surveying) wb...
Yes, likely based on developer and user base initiative. As one person just can't keep track of everything. A summary provided in a paragraph and an image or two. That for sure would be nice.
User avatar
Joel_graff
Posts: 1446
Joined: Fri Apr 28, 2017 4:23 pm
Contact:

Re: Release notes for v0.19

Postby Joel_graff » Tue Mar 05, 2019 12:00 am

I
triplus wrote:
Mon Mar 04, 2019 11:45 pm
Yes, likely based on developer and user base initiative. As one person just can't keep track of everything. A summary provided in a paragraph and an image or two. That for sure would be nice.
I poke around in the threads a lot and a few wb's have caught my eye, just for how quickly the devs created something that looks good. I'll probably add a few as I go, just to track them.

As for bugs, I've seen release notes that are basically just a dump of git commit descriptions - pretty awful to have to read. I'm all for going over the more significant bug squashes, though.
You can find the FreeCAD Trails workbench for transportation engineering on my github at:
https://www.github.com/joelgraff/freecad.trails