Skip to content

Latest commit

 

History

History
41 lines (30 loc) · 3.44 KB

README_DEV.md

File metadata and controls

41 lines (30 loc) · 3.44 KB
Raw

Syncopy Developer Information

These development instructions are only relevant for people on the Syncopy core team.

Making a new Release

PyPI

At github:

  • Keep latest version/changes to be release on the dev branch for now
  • Set the new the package version in pyproject.toml and make sure release notes in the CHANGELOG.md file are up-to-date.
  • After last commit on github, log into the local ESI GitLab installation from within ESI and wait for the sync from Github to happen. The CI pipeline should start all runnners:
    • stage 1: single machine for all architectures like intelllinux, intelwin, macos
    • stage 2: slurm / HPC runners
  • Check + fix all failures. Note that the pipeline on the internal Gitlab differs from the CI run on Github in several ways:
    • parallel tests are run
    • platforms other than linux x64 are used
    • the ESI filesystem/cluster is available, so tests that require large local test data from the cluster's filesystem are run.
  • Once tests are all green, you can do the following:
    • in the gitlab "CI -- pipeline" tab, click on the name of the completed pipeline. You should see the stages. If parts of the pipeline stages 1 or 2 are still running, you can cancel them to unlock stage 3. There is a manual stage 3 'upload' entry named 'pypitest'. Click it to run the pypitest test deployment.
    • If it succeeded: there is a manual stage 4 'deploy' entry named 'pypideploy'. Click it to run the final deployment to pypi.
    • merge dev into master

This concludes the release to PyPI.

Conda

Note: You need to release to PyPI first to start the conda release. Note that this requires that you have proper permissions on your Github account, i.e., you are a maintainer of the esi-syncopy package on conda-forge.

  • Go to https://github.com/conda-forge/esi-syncopy-feedstock and clone the repo to your private Github account. If you already have a clone from the last release, navigate to it and click sync fork to update it.
  • In your up-to-date clone of the esi-syncopy-feedstock repo, create a new branch off main, e.g., release-2023.09. In the new branch, in the file recipe/meta.yaml, do the following steps:
    • Update the version of the Syncopy package and use the file hash of the release on PyPI you did earlier (you can see the hash here on PyPI)
      • Beware: we typically have versions like 2023.07 on Github, and conda is fine with a version like that, too. However, PyPI removes the zero from 2023.07 in the package URL, so you cannot use {{ version }} in the source..url field of the meta.yml file.
    • Check versions of packages in meta.yml here versus versions in pyproject.toml/syncopy.yml in the root of the Syncopy GitHub repo (they need not be 100% identical, but having to old versions in there may lead to security risks or unexpected behaviour with older/buggy package versions).
  • Commit your changes and push to Github. Then to the Github website and create a PR (against https://github.com/conda-forge/esi-syncopy-feedstock, main branch).
  • Fill out the PR checklist in the PR. If the conditions listed in section When to Rerender in the conda documentation apply to the current change/release: request @conda-forge-admin please rerender via comment on GitHub in the PR.
  • Wait for the conda checks. If they are all green, merge.

This concludes the release to conda-forge.