File: development.md

package info (click to toggle)
python-autoray 0.7.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,708 kB
  • sloc: python: 5,490; makefile: 20
file content (29 lines) | stat: -rw-r--r-- 1,075 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
# Development


## Contributing


## Testing


## Building the documentation


## Minting a release

`autoray` uses
[`setuptools_scm`](https://pypi.org/project/setuptools-scm/) to manage versions
and [github actions](https://github.com/jcmgray/autoray/actions) to
automatically publish to [PyPI](https://pypi.org/project/autoray/). To mint a
new release:

1. Make sure all the [tests are passing on CI](https://github.com/jcmgray/autoray/actions/workflows/tests.yml)
2. Tag the version like `vX.X.X` (e.g. `v1.2.3`)
3. Push the tag to github, which will trigger building and uploading a package
   to the [PyPI **test** server](https://test.pypi.org/project/autoray/).
4. If all goes well, create a release on github and publish to trigger building
   and uploading a package to the [PyPI **production** server](https://pypi.org/project/autoray/).
5. The [`conda-forge/autoray-feedstock`](https://github.com/conda-forge/autoray-feedstock)
   repo should automatically pick up the new PyPI release and build a new
   [conda package](https://anaconda.org/conda-forge/autoray).