Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document release process #2539

Merged
merged 1 commit into from Jul 24, 2017

Conversation

jarrodmillman
Copy link
Member

Am I missing anything obvious? We can fine-tune this as we do the 2.0 release.

(I don't mention making a 2.0 branch as I don't think it is necessary. Particularly, if we are releasing 2.1 soon after the 2.0 release.)

@jarrodmillman jarrodmillman added this to the networkx-2.0 milestone Jul 24, 2017
@jarrodmillman jarrodmillman self-assigned this Jul 24, 2017
Copy link
Member

@hagberg hagberg left a comment

Choose a reason for hiding this comment

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

Looks good. It might be more informative to generate a changelog based on pull requests (with labels) since they would have more information about new features, vs bug fix etc.

(Jarrod writing) I started looking into this a bit and it will require a little more thought. The current script doesn't work correctly because PRs haven't been merged consistently. So Git doesn't have all the information about what happened in an easy to parse way. I will look into using the GitHub API to get the PR information. It's been a bit since I worked with the GitHub API so I am going to need to figure out whether there are any nice tools or whether I will need to write something from scratch.

In the meantime, I am going to merge this PR since I would like to at least have the release process documented in master (and since I moved and added some files). I will look into options to replace/improve contribs.py and create a separate PR just for that issue. I will also look into why git isn't able to find all the merged PRs and whether we can do something easy to make sure it can going forward. --Jarrod

- big items ...

There is a `migration guide for people moving from 1.X to 2.0
<http://networkx.readthedocs.org/en/latest/release/migration_guide_from_1.x_to_2.0.html>`_.
Copy link
Member

Choose a reason for hiding this comment

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

We need to update this doc. This page was written when G.nodes(), G.edges(), G.degree(), .... were changed to return iterators and now these functions return views.

Copy link
Member Author

Choose a reason for hiding this comment

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

@MridulS Would you be willing to create a PR to update:

doc/release/migration_guide_from_1.x_to_2.0.rst
doc/release/release_dev.rst

with this and any other changes, which should be noted?

@jarrodmillman jarrodmillman changed the title WIP: Document release process Document release process Jul 24, 2017
@jarrodmillman jarrodmillman merged commit fb8ecc3 into networkx:master Jul 24, 2017
@jarrodmillman jarrodmillman deleted the add-release-doc branch July 26, 2017 01:14
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.

None yet

3 participants