Conversation
…o noosheenvazinkhoo/sc-5455/notebook-for-release-notes
|
I am working on implementing a git diff code explain using OpenAI, marking PR as draft while that's in progress! |
|
The git diff is no bueno!! Script has git diff related functions, will get deleted EOD today (after showing Nik at Community Catchup) |
nrichers
left a comment
There was a problem hiding this comment.
@noosheenv great work! 🥇 I left some initial comments for you to address and will retest afterwards.
Note that the section "Extract PRs from each URL" runs for a long time and never actually finished for me while testing.
…o noosheenvazinkhoo/sc-5455/notebook-for-release-notes
nrichers
left a comment
There was a problem hiding this comment.
🚀 🚀 🚀 🚀 LGTM! (Looks GREAT to me!) I retestest your notebook with some release URLs and every step works as expected — the only thing I was not able to test as-is is the automatic summaries but you had demoed that these work.
One minor comment for myself for the future: we can likely condense some of the cell output by reducing the amount of whitespace we output. But the output now contains all the info you might want which is great.
Very nice work, @noosheenv! I look forward to using this for our next release notes.
|
@nrichers I'm not sure how to resolve these, my attempts did not work! Seems like it's still checking against the OLD filename with the uppercasing instead of honouring the new filename without the uppercasing even when I rename everything ughhh 💀 |
…envazinkhoo/sc-5455/notebook-for-release-notes
@validbeck this branch had a legitimate merge conflict with one of the notebooks (the source, not the output). Fixed that, added all the files, and continued the merge, followed by render. Looks fine now, previously problematic paths included. Note that the PR explanation step is failing due to excessive length, going to merge as not relevant to the technical changes: |
Doesn't |
Yes, it does, and one of those source notebooks had a merge conflict. It's like any other source file that has a merge conflict, you need to actually resolve it. Kinda rare for content we merge in from other repos, but it can happen. |

Internal Notes for Reviewers
I restructured the
generate-release-notes.pyscript to use objects when possible for better data organization and code modularity. Seegenerate-release-objects.pyinside~/release-scriptsfor the updated version. I will delete the old scripts inside ofsite/scriptswhen everything is approved.The notebook is called
generate-release-notes.ipynbinside of~/release-scripts. It imports functions fromgenerate-release-objects.pyto help with abstraction and keeping things simple.For aspects of code that should be modified, I overwrote the function within the notebook so that you can change stuff like the path to your
.envfile, the OpenAI editing prompt, and more. By default, everything should work, so it's fine to not change anything too.Also, I added docstrings, or function specifications to all functions. I did it for proper programming practice and to make the code more readable for open source stuff.
Since this is an internal notebook, the little instructions around the code blocks can be minimal, but right now my instructions are toooooo minimal. I will keep working on that, but in the meantime, feel free to test the notebook and offer suggestions!
External Release Notes