Skip to content

Add versioneer #78

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

Merged
merged 3 commits into from
Jan 24, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
array_api_tests/_version.py} export-subst
3 changes: 3 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
include versioneer.py
include array_api_tests/_version.py}
include array_api_tests/_version.py
45 changes: 43 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,13 +50,54 @@ a specific test case, which is useful when developing functions.
$ pytest array_api_tests/test_creation_functions.py::test_zeros
```

## Releases

The test suite has tagged releases on
[GitHub](https://github.com/data-apis/array-api-tests/releases). If you run
the test suite in your CI system, we recommend pinning against a release tag.

We use [calender versioning](https://calver.org/) for the releases. You should
expect that any version may be "breaking" compared to the previous one, in the
sense that there may have been additional tests added which cause a previously
passing library to fail.

For now, the test suite is
not installable as a Python package. You can use it by cloning the repo and
running `pytest` as described above. If it would help you to be able to
install it as a package, [please let us
know](https://github.com/data-apis/array-api-tests/issues/85).

*Test suite maintainer note:* to make a release of the test suite, make an
annotated tag with the version:

```
git tag -a 2022.1
```

(for the message, just write something like "array-api-tests version 2022.1").
Be sure to use the calver version number for the tag name. Versioneer will
automatically set the version number of the `array_api_tests` package based on
the git tag.

Then push the tag to GitHub

```
git push --tags origin 2022.1
```

Finally go to the [tags page on
GitHub](https://github.com/data-apis/array-api-tests/tags) and convert the tag
into a release. If you want, you can add release notes to the release page on
GitHub.


## What the test suite covers

We are interested in array libraries conforming to the
[spec](https://data-apis.org/array-api/latest/API_specification/index.html).
Ideally this means that if a library has fully adopted the Array API, the test
suite passes. We take great care to _not_ test things which are out-of-scope, so
as to not unexpectedly fail the suite.
suite passes. We take great care to _not_ test things which are out-of-scope,
so as to not unexpectedly fail the suite.

### Primary tests

Expand Down
3 changes: 3 additions & 0 deletions array_api_tests/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,6 @@ def floats(*a, **kw):


st.floats = floats

from . import _version
__version__ = _version.get_versions()['version']
Loading