diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 82149cb3..b01657a3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -67,4 +67,39 @@ Some good tools for profiling memory are ``mprof``. For example, one can memory Then one could plot the memory usage: - mprof plot \ No newline at end of file + mprof plot + +# Making a Release + +1. Ctrl+f and replace all version indicators with the new version. For example, + +`0.5.0dev0` -> `0.5.0` + +2. Write release notes in `whats_new.rst` + +3. Build package locally and test + + + python -m build + +4. Upload to Test PyPi + + + twine upload --repository-url https://test.pypi.org/legacy/ dist/* + + +5. Build docs locally + + make -C build-doc + +6. Push docs under `doc/_build/html/` to the `stable/` folder in `gh-pages` branch + + +7. Make release to PyPi + + + twine upload dist/* + +or if you have two-factor authentication enabled: + + twine upload dist/* --repository mne-connectivity diff --git a/azure-pipelines.yml b/azure-pipelines.yml index afdab8af..1bbe583e 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -5,6 +5,10 @@ trigger: include: - main - maint/* +pr: + branches: + include: + - '*' # must quote since "*" is a YAML reserved character; we want a string jobs: - job: Windows @@ -34,7 +38,7 @@ jobs: pip install git+https://github.com/mne-tools/mne-python pip install --upgrade .[test] codecov displayName: "Install dependencies with pip" - - script: python setup.py develop + - script: pip install . displayName: "Install MNE-Connectivity" - bash: | set -e