Skip to content

Draft 3.0 release notes#6232

Merged
jarrodmillman merged 7 commits intonetworkx:mainfrom
MridulS:release_notes_3.0
Dec 2, 2022
Merged

Draft 3.0 release notes#6232
jarrodmillman merged 7 commits intonetworkx:mainfrom
MridulS:release_notes_3.0

Conversation

@MridulS
Copy link
Copy Markdown
Member

@MridulS MridulS commented Nov 22, 2022

No description provided.

@jarrodmillman jarrodmillman added this to the networkx-3.0 milestone Nov 22, 2022
@jarrodmillman
Copy link
Copy Markdown
Member

@dschult @rossbar @MridulS I normally make the final updates to the release notes when I make the release. Since this PR already renames and the release notes, let's not merge this until I make the release. For now, if anyone else needs to update the release notes, they should make a PR to Mridul's branch. I will make the final pushes to this PR when I make the release and merge it.

No one should edit doc/release/release_dev.rst now, since it will cause conflicts with this PR.

Copy link
Copy Markdown
Member

@dschult dschult left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm sure we will have to add some to the end of this list. But it looks good to me tat the moment. I've got a few typos and small changes to the commit messages below.

@MridulS MridulS changed the title First go through release notes for 3.0 First go through release notes for 3.0 and add release notes for 2.8.{6, 7, 8} Nov 29, 2022
@dschult
Copy link
Copy Markdown
Member

dschult commented Nov 30, 2022

It looks like the contribs.py script which reports all the commits, etc is not collecting the number of commits correctly. Or maybe a better way to say it is that since v2.8.5 all the releases report having the same number of commits. The offending command is: git rev-list networkx-2.8.8..HEAD --count. It works fine up until 2.8.5 and then gets stuck reporting 219 for all the tags 2.8.5-8. I think Jarrod mentioned that something was no longer being updated with each release -- maybe a tag was not created? I can't remember the specifics.

Perhaps we should remove that line from the release notes -- or figure out a way to count the releases between these releases.

@MridulS
Copy link
Copy Markdown
Member Author

MridulS commented Dec 1, 2022

I fixed this locally but didn't push the updated the contribs.py as I haven't really tested it properly. The release notes for 2.8.5 should be fine in this PR.
The 3.0 ones are based on top of 2.8.5 currently, should I do it on top of 2.8.8 or 2.8?

@MridulS
Copy link
Copy Markdown
Member Author

MridulS commented Dec 1, 2022

I've pushed the updated contribs.py file too, it isn't really tested much but it can be used for generating notes by comparing 2 old releases.

@MridulS MridulS changed the title First go through release notes for 3.0 and add release notes for 2.8.{6, 7, 8} Release notes for 3.0 and 2.8.{6, 7, 8}, update contribs.py to generate commits behind 2 old releases Dec 1, 2022
@MridulS MridulS marked this pull request as ready for review December 1, 2022 13:04
@jarrodmillman jarrodmillman changed the title Release notes for 3.0 and 2.8.{6, 7, 8}, update contribs.py to generate commits behind 2 old releases Draft 3.0 release notes Dec 2, 2022
They were inconsistent with existing release notes, which I will grab
from the old releases.
@jarrodmillman
Copy link
Copy Markdown
Member

I removed the 2.8.6, 2.8.7, and 2.8.8 release notes since they weren't consistent with the actuall 2.8.6, 2.8.7, and 2.8.8 release notes. I am not sure what the issue was but the ones here included things that weren't in the releases. I just need to grab them from the 2.8 release branch, which was the original plan for this release. I also converted the draft release notes back to a dev name, since I normally make the name change at the last moment as part of the release process. I will need to update the release notes then anyway.

For the next release, we should stick with the old pattern of just updating the relevant sections in the draft and wait to finalize the release notes and run the contrib.py script when it is time. There is no advantage to run it more than once.

I kept the changes to contrib.py for now, but will review whether the scripts still works as expected when I make the release.

@jarrodmillman
Copy link
Copy Markdown
Member

Once the tests pass, this is ready to merge and I can start the release process. Thanks!

@jarrodmillman jarrodmillman merged commit b37d593 into networkx:main Dec 2, 2022
MridulS added a commit to MridulS/networkx that referenced this pull request Feb 4, 2023
* First go through release notes for 3.0

* Add release notes for 2.8.6, 2.8.7 and 2.8.8

* Update doc/release/release_3.0.rst

Co-authored-by: Dan Schult <dschult@colgate.edu>

* Apply suggestions from code review

Co-authored-by: Dan Schult <dschult@colgate.edu>

* use contribs.py to find commits b/w any 2 release tags

* Update release notes

* Remove 2.8.6 through 2.8.8 release notes

They were inconsistent with existing release notes, which I will grab
from the old releases.

Co-authored-by: Dan Schult <dschult@colgate.edu>
Co-authored-by: Jarrod Millman <jarrod.millman@gmail.com>
cvanelteren pushed a commit to cvanelteren/networkx that referenced this pull request Apr 22, 2024
* First go through release notes for 3.0

* Add release notes for 2.8.6, 2.8.7 and 2.8.8

* Update doc/release/release_3.0.rst

Co-authored-by: Dan Schult <dschult@colgate.edu>

* Apply suggestions from code review

Co-authored-by: Dan Schult <dschult@colgate.edu>

* use contribs.py to find commits b/w any 2 release tags

* Update release notes

* Remove 2.8.6 through 2.8.8 release notes

They were inconsistent with existing release notes, which I will grab
from the old releases.

Co-authored-by: Dan Schult <dschult@colgate.edu>
Co-authored-by: Jarrod Millman <jarrod.millman@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

3 participants