From 614e5f3a72db309a3dee996d7241317556883e8d Mon Sep 17 00:00:00 2001 From: Chris Palmer Date: Wed, 3 Mar 2021 19:27:25 +0000 Subject: [PATCH] Issues in the changelog now link to to the issue. --- CHANGELOG.md | 12 +++++++----- scripts/changelog.py | 17 ++++++++++------- 2 files changed, 17 insertions(+), 12 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b17c321..c1294d2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,8 @@ This changelog is generated by `changelog.py` using manually added semantic version tags to classify commits as breaking changes, additions or fixes. +* 2021-03-03 [`a7eae4f`](https://github.com/nophead/NopSCADlib/commit/a7eae4f549b51dbe4624a8b67012919cef6cb24a "show commit") [C.P.](# "Chris Palmer") Neater changlog format. + * 2021-03-03 [`7b770ab`](https://github.com/nophead/NopSCADlib/commit/7b770abe12b71fa4b4f7415aa9f46d0f2c9d54f1 "show commit") [C.P.](# "Chris Palmer") Udpated changelog * 2021-03-03 [`31ab856`](https://github.com/nophead/NopSCADlib/commit/31ab8562a783464f93812b8c7c45d403587efd0a "show commit") [C.P.](# "Chris Palmer") Updated images @@ -13,7 +15,7 @@ This changelog is generated by `changelog.py` using manually added semantic vers * 2021-03-03 [`4a2951e`](https://github.com/nophead/NopSCADlib/commit/4a2951e22f7398f28850f459c7542a7a2d1e0c9c "show commit") [C.P.](# "Chris Palmer") Fixed `changelog.py` for when HEAD doesn't have tag. -* 2021-03-03 [`a93a8f9`](https://github.com/nophead/NopSCADlib/commit/a93a8f99fb8272186c99207161bc50c2cc3e057f "show commit") [C.P.](# "Chris Palmer") Added `CHANGELOG.md` for #154 +* 2021-03-03 [`a93a8f9`](https://github.com/nophead/NopSCADlib/commit/a93a8f99fb8272186c99207161bc50c2cc3e057f "show commit") [C.P.](# "Chris Palmer") Added `CHANGELOG.md` for [#154](https://github.com/nophead/NopSCADlib/issues/154 "show issue") ### [v13.4.0](https://github.com/nophead/NopSCADlib/releases/tag/v13.4.0 "show release") Additions [...](https://github.com/nophead/NopSCADlib/compare/v13.3.1...v13.4.0 "diff with v13.3.1") * 2021-02-22 [`c69100b`](https://github.com/nophead/NopSCADlib/commit/c69100bd71254933c21fdf7bed21676b612564a6 "show commit") [C.P.](# "Chris Palmer") Added spring steel and silicone sheets. @@ -461,7 +463,7 @@ Rail test can now move the carriages with customiser. * 2020-11-20 [`25dceee`](https://github.com/nophead/NopSCADlib/commit/25dceee20a15411a2d74dfd9faf2c6e7bb0b9ae0 "show commit") [M.B.](# "Martin Budden") Made hflip and vflip conditional. #### [v10.7.1](https://github.com/nophead/NopSCADlib/releases/tag/v10.7.1 "show release") Fixes [...](https://github.com/nophead/NopSCADlib/compare/v10.7.0...v10.7.1 "diff with v10.7.0") -* 2020-11-19 [`d70ddf5`](https://github.com/nophead/NopSCADlib/commit/d70ddf53592fcbb62469cdae48ec91d809d55e48 "show commit") [C.P.](# "Chris Palmer") Type in drag chain blurb, fixes #100 +* 2020-11-19 [`d70ddf5`](https://github.com/nophead/NopSCADlib/commit/d70ddf53592fcbb62469cdae48ec91d809d55e48 "show commit") [C.P.](# "Chris Palmer") Type in drag chain blurb, fixes [#100](https://github.com/nophead/NopSCADlib/issues/100 "show issue") * 2020-11-18 [`70b6052`](https://github.com/nophead/NopSCADlib/commit/70b60522cef38a46a77fad7d8f500a6a9bc5c0cb "show commit") [C.P.](# "Chris Palmer") Added `drag_chain` to the cover picture. @@ -919,7 +921,7 @@ First column split of vitamins now at J. * 2020-04-05 [`6545593`](https://github.com/nophead/NopSCADlib/commit/65455930f8d4b3d5b6a4ae630684e1384792afee "show commit") [C.P.](# "Chris Palmer") Reverted incorrect use of `stl_colour()`. -* 2020-04-05 [`7e0c5fd`](https://github.com/nophead/NopSCADlib/commit/7e0c5fdb6e7da03a42cc81d87639421821e8b13e "show commit") [C.P.](# "Chris Palmer") Renders of STLs are now the correct colour. Fixes #71 +* 2020-04-05 [`7e0c5fd`](https://github.com/nophead/NopSCADlib/commit/7e0c5fdb6e7da03a42cc81d87639421821e8b13e "show commit") [C.P.](# "Chris Palmer") Renders of STLs are now the correct colour. Fixes [#71](https://github.com/nophead/NopSCADlib/issues/71 "show issue") ## [v6.0.0](https://github.com/nophead/NopSCADlib/releases/tag/v6.0.0 "show release") Breaking Changes [...](https://github.com/nophead/NopSCADlib/compare/v5.0.1...v6.0.0 "diff with v5.0.1") * 2020-04-04 [`bc4e18d`](https://github.com/nophead/NopSCADlib/commit/bc4e18d788a0df773497b20ba958501855cd2a10 "show commit") [C.P.](# "Chris Palmer") The assembly module now has a big parameter to force large or small views. @@ -1028,7 +1030,7 @@ The implementation files are still lower case for backwards compatibility. #### [v4.0.1](https://github.com/nophead/NopSCADlib/releases/tag/v4.0.1 "show release") Fixes [...](https://github.com/nophead/NopSCADlib/compare/v4.0.0...v4.0.1 "diff with v4.0.0") * 2020-03-01 [`3433511`](https://github.com/nophead/NopSCADlib/commit/343351155c0146a990300cdb76ca054146036f8f "show commit") [C.P.](# "Chris Palmer") Made library search order deterministic by sorting the result of `os.listdir()` -* 2020-03-01 [`c41b1fa`](https://github.com/nophead/NopSCADlib/commit/c41b1fa1151fb5a7fe09cb3a4fb53c79ab99de71 "show commit") [C.P.](# "Chris Palmer") Fix for issue #57, now searches multiple directories. +* 2020-03-01 [`c41b1fa`](https://github.com/nophead/NopSCADlib/commit/c41b1fa1151fb5a7fe09cb3a4fb53c79ab99de71 "show commit") [C.P.](# "Chris Palmer") Fix for issue [#57,](https://github.com/nophead/NopSCADlib/issues/57, "show issue") now searches multiple directories. * 2020-03-02 [`7b76ace`](https://github.com/nophead/NopSCADlib/commit/7b76aceaadf5f2089ea20b0acb60ac831cd35079 "show commit") [C.P.](# "Chris Palmer") Changed microswitch include to a use. @@ -1045,7 +1047,7 @@ Since `kp_pillow_blocks` includes ball bearings, they were also missing. * 2020-03-01 [`7706716`](https://github.com/nophead/NopSCADlib/commit/7706716fa28c35815ad9770ce00130721d2d2cd3 "show commit") [C.P.](# "Chris Palmer") Updated readme for threads. ## [v4.0.0](https://github.com/nophead/NopSCADlib/releases/tag/v4.0.0 "show release") Breaking Changes [...](https://github.com/nophead/NopSCADlib/compare/v3.2.2...v4.0.0 "diff with v3.2.2") -* 2020-03-01 [`c815c15`](https://github.com/nophead/NopSCADlib/commit/c815c1592d690812b42b821273766612dae4b1f5 "show commit") [C.P.](# "Chris Palmer") `SHOW_THREADS` renamed `NOPSCADLIB_SHOW_THREADS` for #61 +* 2020-03-01 [`c815c15`](https://github.com/nophead/NopSCADlib/commit/c815c1592d690812b42b821273766612dae4b1f5 "show commit") [C.P.](# "Chris Palmer") `SHOW_THREADS` renamed `NOPSCADLIB_SHOW_THREADS` for [#61](https://github.com/nophead/NopSCADlib/issues/61 "show issue") #### [v3.2.2](https://github.com/nophead/NopSCADlib/releases/tag/v3.2.2 "show release") Fixes [...](https://github.com/nophead/NopSCADlib/compare/v3.2.1...v3.2.2 "diff with v3.2.1") * 2020-03-01 [`e32ef88`](https://github.com/nophead/NopSCADlib/commit/e32ef88c90722e815e51f87181028119b026e3aa "show commit") [C.P.](# "Chris Palmer") Small optimisation to `views.py` diff --git a/scripts/changelog.py b/scripts/changelog.py index ef1ae77..c5c66f6 100644 --- a/scripts/changelog.py +++ b/scripts/changelog.py @@ -70,14 +70,17 @@ def iscode(word): return False -def codify(word): +def codify(word, url): """ if a word is deemed code enclose it backticks """ - if word and iscode(word): - return '`' + word + '`' + if word: + if re.match(r'#[0-9]+', word): + return '[%s](%s "show issue")' % (word, url + '/issues/' + word[1:]) + if iscode(word): + return '`' + word + '`' return word -def fixup_comment(comment): +def fixup_comment(comment, url): """ markup code words and fix new paragraphs """ result = '' word = '' @@ -88,11 +91,11 @@ def fixup_comment(comment): if c == '`': code = not code # Keep track of state else: if c in ' \n' or (c == '.' and (i + 1 == len(comment) or comment[i + 1] in ' \n')): # if a word terminator - result += codify(word) + c # Add codified word before terminator + result += codify(word, url) + c # Add codified word before terminator word = '' else: word += c # Accumulate next word - result += codify(word) # In case comment ends without a terminator + result += codify(word, url) # In case comment ends without a terminator return result.replace('\n\n','\n\n * ') # Give new paragraphs a bullet point class Commit(): # members dynamically added from commit_fields @@ -157,4 +160,4 @@ if __name__ == '__main__': # Print commits excluding merges if not c.comment.startswith('Merge branch') and not c.comment.startswith('Merge pull'): - print('* %s [`%s`](%s "show commit") %s %s\n' % (c.date, c.hash[:7], url + '/commit/' + c.hash, initials(c.author), fixup_comment(c.comment)), file = file) + print('* %s [`%s`](%s "show commit") %s %s\n' % (c.date, c.hash[:7], url + '/commit/' + c.hash, initials(c.author), fixup_comment(c.comment, url)), file = file)