Prepare for v2.0.0 development.

CHANGELOG.md

@@ -1,9 +1,18 @@
 # xdmod-data Changelog
 
-## Main development branch
+## v2.x.y (main development branch)
+
+- Prepare for v2.0.0 development ([\#42](https://github.com/ubccr/xdmod-data/pull/42)).
+
+## v1.0.2 (2024-10-31)
+
+This release fixes an `IOPub` error that can occur when calling
+`get_raw_data()` with `show_progress=True`.
+
+It is compatible with Open XDMoD versions 11.0.x and 10.5.x.
 
 - Document Open XDMoD compatibility in changelog ([\#31](https://github.com/ubccr/xdmod-data/pull/31)).
-- Fix IOPub error when showing progress with `get_raw_data()` ([\#38](https://github.com/ubccr/xdmod-data/pull/38)).
+- Fix IOPub error when showing progress with `get_raw_data()` ([\#39](https://github.com/ubccr/xdmod-data/pull/39)).
 
 ## v1.0.1 (2024-09-27)
 

README.md

@@ -1,6 +1,13 @@
 # xdmod-data
 As part of the Data Analytics Framework for [XDMoD](https://open.xdmod.org), this Python package provides API access to the data warehouse of instances of Open XDMoD.
 
+This documentation is for **v2.x.y (main development branch)**. For documentation of other versions:
+
+- [v1.0.2](https://github.com/ubccr/xdmod-data/tree/v1.0.2?tab=readme-ov-file#xdmod-data)
+- [v1.0.1](https://github.com/ubccr/xdmod-data/tree/v1.0.1?tab=readme-ov-file#xdmod-data)
+- [v1.0.0](https://github.com/ubccr/xdmod-data/tree/v1.0.0?tab=readme-ov-file#xdmod-data)
+- [v1.x.y (development branch)](https://github.com/ubccr/xdmod-data/tree/v1.x.y?tab=readme-ov-file#xdmod-data)
+
 The package can be installed from PyPI via `pip install xdmod-data`.
 
 Existing installations can be upgraded via `pip install --upgrade xdmod-data`.
@@ -14,7 +21,7 @@ Specific versions of this package are compatible with specific versions of Open
 
 | `xdmod-data` version | Open XDMoD versions |
 | -------------------- | ------------------- |
-| 1.0.1                | 11.0.x, 10.5.x      |
+| 1.0.2, 1.0.1         | 11.0.x, 10.5.x      |
 | 1.0.0                | 10.5.x              |
 
 ## API Token Access

docs/developing.md

@@ -38,8 +38,19 @@
 ## Releasing a new version
 1. Make a new branch of `xdmod-data` and:
     1. Make sure the version number is updated in `xdmod_data/__version__.py`.
-    1. Update the Open XDMoD compatibility matrix in the `README.md`.
-    1. Update `CHANGELOG.md` to change "Main development branch" to, e.g., `v1.0.1 (2024-06-XX)`.
+    1. In `README.md`:
+        1. Under the main heading,
+            1. In the sentence that begins, `This documentation is for ...`,
+               replace the version number in bold, e.g.:
+                ```
+                This documentation is for **v1.0.2**.
+                ```
+        1. Update the Open XDMoD compatibility matrix.
+    1. Update `CHANGELOG.md` to:
+        1. Change the `development branch` to, e.g., `v1.0.1 (2024-06-XX)`.
+        1. Add a summary of the changes in the version, including the
+           compatibilty with Open XDMoD versions.
+    1. In `setup.cfg`, update the `long_description` to change the version number in the URL to the new version.
     1. Create a Pull Request for the new version.
 1. After the Pull Request is approved (but not merged yet), follow these steps in a cloned copy of the branch:
     1. Start up a virtual environment, e.g.:
@@ -83,16 +94,40 @@
 1. Go to [create a new release on GitHub](https://github.com/ubccr/xdmod-data/releases/new) and:
     1. Click `Choose a tag`.
     1. Type in a tag similar to `v1.0.0` and choose `Create new tag`.
+    1. Choose the correct target based on the major version you are developing.
     1. Make the release title the same as the tag name (e.g., `v1.0.0`).
+    1. Where it says `Describe this release`, paste in the contents of the
+       release's section in `CHANGELOG.md`. Note that single newlines are
+       interpreted as line breaks, so you may need to reformat the description
+       to break the lines where you want them to break.
     1. Where it says `Describe this release`, paste in the contents of the release's section in `CHANGELOG.md`.
-    1. Where it says `Attach binaries`, attach the built distribution that was uploaded to PyPI.
+    1. Where it says `Attach binaries`, attach the built distribution (the `.whl` file) that was uploaded to PyPI.
     1. Click `Publish release`.
     1. Go to the [GitHub milestones](https://github.com/ubccr/xdmod-data/milestones) and close the milestone for the version.
 
 ## After release
-1. Make a new branch of `xdmod-data` and:
-    1. Make sure the version number is updated in `xdmod_data/__version__.py` to a pre-release of the next version, e.g., `1.0.1-01`.
-    1. Update `CHANGELOG.md` to add a section at the top called `Main development branch`.
-    1. Go to the [GitHub milestones](https://github.com/ubccr/xdmod-data/milestones) and add a milestone for the version.
-    1. Create a Pull Request for the new version.
-    1. Once the Pull Request is approved, merge it into `main`.
+1. If this is a minor or patch release to a version that is not the most recent
+   major version,
+    1. For each major version above this release's major version, in a Pull
+       Request,
+        1. Add the entry for this version to the `CHANGELOG.md`.
+        1. In the `README.md`:
+            1. Add an item to the top of the bulleted list for
+               the new version, making sure to replace the version number in
+               the link text and in the URL.
+            1. Update the Open XDMoD compatibility matrix.
+1. In a Pull Request to the `main` branch of `xdmod-data`:
+    1. Make sure the version number is updated in `xdmod_data/__version__.py`
+       to a development pre-release of the next version, e.g., `1.0.1.dev1`.
+    1. In `README.md`, under the main heading, in the sentence that begins,
+       `This documentation is for ...`, replace the version number in bold,
+       e.g.:
+        ```
+        This documentation is for **v1.x.y (development branch)**.
+        ```
+    1. Update `CHANGELOG.md` to add a section at the top called
+       `v1.x.y (development branch)`, replacing `1` with the major version under
+       development (add `main` before `development branch` if it is also the
+       main development branch.
+1. Go to the [GitHub milestones](https://github.com/ubccr/xdmod-data/milestones)
+   and add a milestone for the version under development.