Skip to content

Making a release

Craig Macdonald edited this page Nov 1, 2023 · 13 revisions

PyTerrier Release

  • Bump the version in pyterrier/__init__.py
  • Run rm -f dist/*.tar.gz; python setup.py sdist to generate a .tar.gz file in the dist folder
  • Ensure you can install the .tar.gz file, pip install dist/*.tar.gz
  • Commit pyterrier/__init__.py and push to github
  • Run the pypi packaging github action while ensuring that the releasetype input is set to 'test'
  • The resulting tar file will become available from https://test.pypi.org/project/python-terrier/
  • Use a colab instance to test install the test release - one cell containing !pip install http://path/to/tesdt pypi.tar.gz Using pip install the version number using test.pypi.org will not work.
  • Run the pypi packaging github action while ensuring that the releasetype input is set to 'release'
  • New file appears in https://pypi.org/project/python-terrier/#files
  • Use a colab instance to test install the final release - !pip install python-terrier

Making Release Notes:

cd pyterrier
gh issue list -S "is:issue is:closed milestone:0.7 " | cut -f1,3
gh pr list -S "is:pr is:closed milestone:0.7 "

Terrier-python-helper

mvn versions:set -DnewVersion=5.0
mvn versions:commit
#on Mac
export GPG_TTY=$(tty)
mvn clean package deploy

Errors:

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-deploy-plugin:2.8.2:deploy (default-deploy) on project terrier-python-helper: Failed to deploy artifacts: Could not transfer artifact org.terrier:terrier-python-helper:jar:0.0.8 from/to ossrh (https://oss.sonatype.org/service/local/staging/deploy/maven2/): PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target 

-> use a newer Java version

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-deploy-plugin:2.8.2:deploy (default-deploy) on project terrier-python-helper: Failed to deploy artifacts: Could not transfer artifact org.terrier:terrier-python-helper:jar:0.0.8 from/to ossrh (https://oss.sonatype.org/service/local/staging/deploy/maven2/): status code: 401, reason phrase: Unauthorized (401) -> [Help 1]

-> ensure you have ~/.m2/settings.xml file that can login to oss.sonatype.org

Clone this wiki locally