Skip to content

Latest commit

 

History

History
96 lines (64 loc) · 2.98 KB

DEPLOY.md

File metadata and controls

96 lines (64 loc) · 2.98 KB

Deployment of sisl

This document describes the deployment details to perform a version release (or development release).

Version release

A version release cycle must not contain any changes to the code other than the below specified changes. Any pending commits should be committed before proceeding with the below sequence.

The release cycle should be performed like this:

  1. Update released versions in CHANGELOG.md and CITATION.cff

  2. Insert correct dates in CITATION.cff (for Zenodo)

  3. Create release notes and changelogs:

    1. Create the release-notes:

      Also append the changelog.

      towncrier build --version 0.14.1 --yes

      This will create a file here: docs/release/0.14.1-notes.rst.

    2. Create simpler release notes (for Github):

      # append to towncrier release notes:
python tools/changelog.py --format rst $GH_TOKEN v0.14.0..v0.14.1 >> docs/release/0.14.1-notes.rst
python tools/changelog.py --format md $GH_TOKEN v0.14.0..v0.14.1 > changelog.md

  4. Amend release notes:

    Amend to docs/release.rst something like this:

    0.14.1 <release/0.14.1-notes.rst>

  5. Commit changes.

  6. Tag the commit with:

    git tag -a "vVERSION" -m "Releasing vVERSION"

  7. Create tarballs and wheels and upload them

    These steps should be done via the github actions step, so generally not required.

    python3 -m pip install --upgrade build
python3 -m build
python3 -m pip install --upgrade twine
# requires .pypirc with testpypi section
python3 -m twine upload --repository testpypi dist/*

# test installation, preferably in a venv
python3 -m pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ sisl

# once checked, upload to pypi
python3 -m twine upload dist/sisl-0.12.0.tar.gz

  8. Create conda uploads.

    The conda uploads are based on conda-forge and an associated sisl-feedstock is used. To update it, follow these steps:

    1. branch off https://github.com/conda-forge/sisl-feedstock
    2. Edit recipe/meta.yaml by updating version and sha256
    3. Propose merge-request.
    4. Check CI succeeds.
    5. Accept merge and the new version will be uploaded.

  9. Update pyodide version

    Until web assembly (wasm) wheels are supported by PyPi, they are managed directly in the pyodide repository. The update steps are very similar to conda, except all packages are managed in a single repository. The meta.yaml is at packages/sisl/meta.yaml. Follow these steps:

    1. branch off https://github.com/pyodide/pyodide
    2. Edit packages/sisl/meta.yaml by updating version, source url and sha256
    3. Propose merge-request.
    4. Check CI succeeds. If it doesn't you can test locally by following instructions here
    5. Wait for the pyodide team to accept your request.