Merge pull request #94 from asmeurer/release

2.2 release

Author: asmeurer

docs/changelog.md

@@ -1,8 +1,39 @@
 # Changelog
 
+## 2.2 (2024-11-11)
+
+### Major Changes
+
+- Preliminary support for the draft 2024.12 version of the standard is now
+  implemented. This is disabled by default, but can be enabled with the [flags
+  API](array-api-strict-flags), e.g., by calling
+  `set_array_api_strict_flags(api_version='2024.12')` or setting
+  `ARRAY_API_STRICT_API_VERSION=2024.12`.
+
+  Note that this support is still preliminary and still relatively untested.
+  Please [report any
+  issues](https://github.com/data-apis/array-api-strict/issues) you find.
+
+  The following functions are implemented for 2024:
+
+  - `diff`
+  - `nextafter`
+  - `reciprocal`
+  - `take_along_axis`
+  - The `'max dimensions'` key of `__array_namespace_info__().capabilities()`.
+
+  Some planned changes to the 2024.12 standard, including scalar support for
+  array functions, is not yet implemented but will be in a future version.
+
+### Minor Changes
+
+- `__array_namespace_info__()` now returns a class instead of a module. This
+  prevents extraneous names that aren't part of the standard from appearing on
+  it.
+
 ## 2.1.3 (2024-11-08)
 
-## Major Changes
+### Major Changes
 
 - Revert the change to require NumPy >= 2.1 and Python >= 3.10 from
   array-api-strict 2.1.2. array-api-strict now requires NumPy >= 1.21 and
@@ -18,7 +49,7 @@
 
 ## 2.1.2 (2024-11-07)
 
-## Major Changes
+### Major Changes
 
 - array-api-strict now requires NumPy >= 2.1 and Python >= 3.10
 

docs/index.md

@@ -197,4 +197,5 @@ git_filter_repo.py --path numpy/array_api/ --path-rename numpy/array_api:array_a
 
 api.rst
 changelog.md
+releasing.md
 ```

docs/releasing.md

@@ -0,0 +1,37 @@
+# Releasing
+
+To release array-api-strict:
+
+- Create a release branch and make a PR on GitHub.
+
+- Update `changelog.md` with the changes for the release.
+
+- Make sure the CI is passing on the release branch PR. Also double check that
+  you have properly pulled `main` and merged it into the release branch so
+  that the branch contains all the necessary changes for the release.
+
+- When you are ready to make the release, create a tag with the release number
+
+  ```
+  git tag -a 2.2 -m "array-api-strict 2.2"
+  ```
+
+  and push it up to GitHub
+
+  ```
+  git push origin --tags
+  ```
+
+  This will trigger the `publish-package` build on GitHub Actions. Make sure
+  that build works correctly and pushes the release up to PyPI. If something
+  goes wrong, you may need to delete the tag from GitHub and try again.
+
+  Note that the `array_api_strict.__version__` version as well as the version
+  in the package metadata is all automatically computed from the tag, so it is
+  not necessary to update the version anywhere else.
+
+- Once the release is published, you can merge the PR.
+
+- The conda-forge bot will automatically send a PR to the
+  [array-api-strict-feedstock](https://github.com/conda-forge/array-api-strict-feedstock)
+  updating the version, which you should merge.