[pyos][docs] Where is the changelog stored? #472

Activity

1. eriknw commented on Jun 26, 2023

   

   eriknw

   on Jun 26, 2023

   Member

   More actions

   The changelog is currently only on GitHub.

   The main reason we don't also have a file is developer bandwidth, and I don't know how important it actually is to have.

   Does anybody want to create/maintain CHANGELOG.md or create/find a tool to make it easy to keep up to date?
2. szhorvat commented on Jun 26, 2023

   

   szhorvat

   on Jun 26, 2023

   Author

   More actions

   At one point I was trying to search for certain changes, and a single changelog file would have been helpful.

   To be clear, I do not consider this very important, certainly not a blocker for the review.

   GitHub has an API which makes it easy to retrieve release notes, and automatically construct the first version of a changelog file.
3. szhorvat commented on Jun 26, 2023

   

   szhorvat

   on Jun 26, 2023

   Last edited by szhorvat

   Author

   More actions

   Here's the transcript of a very quick attempt to retrieve the release notes in Mathematica:

   In[22]:= 
   rels = Import["https://api.github.com/repos/python-graphblas/python-graphblas/releases", "RawJSON"];
   
   In[23]:= Length[rels]
   Out[23]= 30
   
   In[24]:= str = StringRiffle[
      StringTemplate["# `name`\n\n`body`"] /@ rels[[All, {"name", "body"}]],
      "\n\n\n"
     ];
   
   In[25]:= Export["CHANGELOG.md", str, "String"]
   Out[25]= "CHANGELOG.md"

   Result:

   CHANGELOG.md.zip

   👍React with 👍1Reacted by Sultan Orazbayev
4. SultanOrazbayev commented on Jun 26, 2023

   

   SultanOrazbayev

   on Jun 26, 2023

   Member

   More actions

   @szhorvat Wow, thank you, this was super quick!

   @eriknw Should we use this changelog as a starting point and add all future notes to it?
5. eriknw commented on Jun 26, 2023

   

   eriknw

   on Jun 26, 2023

   Member

   More actions

   Nice! This does seem like a nice starting point. Some questions:

   • Can we create a script to automatically change #123 to a link that points to that PR?
   • Should we add changelog to the documentation?
   • Should we include or exclude the changelog in MANIFEST.in?

   The release workflow would then be a bit different: we'd need to add the latest changes to the changelog in the repo before we cut a release.
6. SultanOrazbayev commented on Jun 27, 2023

   

   SultanOrazbayev

   on Jun 27, 2023

   Member

   More actions

   Can we create a script to automatically change #123 to a link that points to that PR?

   Here's a quick sed that might be useful:

   sed -e "s'(#\([0-9]*\))'([#\1](https://github.com/python-graphblas/python-graphblas/pull/\1))'g" CHANGELOG.md