Debian Codegraph @

docs/development.md

raw
1 # Development
2
3
4 ## Contributing
5
6
7 ## Testing
8
9
10 ## Building the documentation
11
12
13 ## Minting a release
14
15 `autoray` uses
16 [`setuptools_scm`](https://pypi.org/project/setuptools-scm/) to manage versions
17 and [github actions](https://github.com/jcmgray/autoray/actions) to
18 automatically publish to [PyPI](https://pypi.org/project/autoray/). To mint a
19 new release:
20
21 1. Make sure all the [tests are passing on CI](https://github.com/jcmgray/autoray/actions/workflows/tests.yml)
22 2. Tag the version like `vX.X.X` (e.g. `v1.2.3`)
23 3. Push the tag to github, which will trigger building and uploading a package
24 to the [PyPI **test** server](https://test.pypi.org/project/autoray/).
25 4. If all goes well, create a release on github and publish to trigger building
26 and uploading a package to the [PyPI **production** server](https://pypi.org/project/autoray/).
27 5. The [`conda-forge/autoray-feedstock`](https://github.com/conda-forge/autoray-feedstock)
28 repo should automatically pick up the new PyPI release and build a new
29 [conda package](https://anaconda.org/conda-forge/autoray).