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

[szhorvat]

I can see that there is a changelog hosted on GitHub as part of releases, but I was wondering if there's a changelog file somewhere as part of the source code package. If not, it would be useful to set one up:

• It would be kept even if you move from GitHub
• It would be easily searchable

Part of: pyOpenSci/software-submission#81

[eriknw]

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?

[szhorvat]

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.

[szhorvat]

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

[SultanOrazbayev]

@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?

[eriknw]

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.

[SultanOrazbayev]

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