Skip to content

Commit

Permalink
update changelog and upversion
Browse files Browse the repository at this point in the history
  • Loading branch information
nwlandry committed Aug 24, 2024
1 parent a1d5b11 commit cf1bf78
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 2 deletions.
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# Changelog

## v0.8.8
* Added the ability to read and write files according the HIF functionality standard [#572](https://github.com/xgi-org/xgi/pull/572) (@nwlandry).
* Implemented the `add_node_to_edge` and `remove_node_from_edge` methods for DiHypergraphs [#571](https://github.com/xgi-org/xgi/pull/571) (@nwlandry).
* Allow empty edges [#565](https://github.com/xgi-org/xgi/pull/565)
* Simplified the `cleanup()` methods [#569](https://github.com/xgi-org/xgi/pull/569) (@nwlandry).
* Fix Issue [#566](https://github.com/xgi-org/xgi/issues/566) [#567](https://github.com/xgi-org/xgi/pull/567) (@maximelucas).
* Added documentation about N vs. N-1 in the `var()` and `std()` methods in the stats module [#562](https://github.com/xgi-org/xgi/pull/562) (@nwlandry).
* Fix Issue [#552](https://github.com/xgi-org/xgi/issues/552) [#561](https://github.com/xgi-org/xgi/pull/561) (@nwlandry).

## v0.8.7
* Renamed the `_hypergraph` internal variable to `_net_attr` [#560](https://github.com/xgi-org/xgi/pull/560) (@nwlandry).
* Get rid of KeyErrors in `to_line_graph` [#558](https://github.com/xgi-org/xgi/pull/558) (@pgberlureau).
Expand Down
1 change: 1 addition & 0 deletions HOW_TO_CONTRIBUTE.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Please note we have a [code of conduct](/CODE_OF_CONDUCT.md), please follow it i
10. You may merge the Pull Request in once you have the sign-off of at least one other developer, or if you do not have permission to do that, you may request the reviewer to merge it for you.

## New Version process

1. Make sure that the Github Actions workflow runs without any errors.
2. Using the `github-changelog` package (a dependency in the [release](requirements/release.txt) requirements file), run `changelog -m xgi-org xgi [last release tag]` to get the merged pull requests with their links. Paste this into the changelog file under a new heading and edit to make more legible. Associate a GitHub username with each pull request.
3. Increase the version number in [\_\_init\_\_.py](xgi/__init__.py.py) and [conf.py](docs/source/conf.py) to the new version agreed upon by the core developers. The versioning scheme we use is [SemVer](http://semver.org/).
Expand Down
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
# -- Project information -----------------------------------------------------
project = "XGI"
copyright = "Copyright (C) 2021-2024 XGI Developers"
release = "0.8.7"
release = "0.8.8"

# -- General configuration ---------------------------------------------------

Expand Down
2 changes: 1 addition & 1 deletion xgi/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@
from .stats import *


__version__ = "0.8.7"
__version__ = "0.8.8"

0 comments on commit cf1bf78

Please sign in to comment.