diff --git a/setup.py b/setup.py index 1ce2c9352..28e7d8ec1 100644 --- a/setup.py +++ b/setup.py @@ -6,53 +6,21 @@ VERSION needs to be formatted following the MAJOR.MINOR.PATCH convention (we need to follow this convention to be able to retrieve versioned scripts) -Simple check list for release from AllenNLP repo: https://github.com/allenai/allennlp/blob/master/setup.py - To create the package for pypi. -0. Prerequisites: - - Dependencies: - - twine: "pip install twine" - - Create an account in (and join the 'evaluate' project): - - PyPI: https://pypi.org/ - - Test PyPI: https://test.pypi.org/ - -1. Change the version in: +1. Open a PR and change the version in: - __init__.py - setup.py + Then merge the PR once it's approved. -2. Commit these changes: "git commit -m 'Release: VERSION'" - -3. Add a tag in git to mark the release: "git tag VERSION -m 'Add tag VERSION for pypi'" +3. Add a tag "vVERSION" (e.g. v0.4.1) in git to mark the release : "git tag vVERSION -m 'Add tag vVERSION for pypi'" Push the tag to remote: git push --tags origin main + Then verify that the 'Python release' CI job runs and succeeds. -4. Build both the sources and the wheel. Do not change anything in setup.py between - creating the wheel and the source distribution (obviously). - - First, delete any "build" directory that may exist from previous builds. - - For the wheel, run: "python setup.py bdist_wheel" in the top level directory. - (this will build a wheel for the python version you use to build it). - - For the sources, run: "python setup.py sdist" - You should now have a /dist directory with both .whl and .tar.gz source versions. - -5. Check that everything looks correct by uploading the package to the pypi test server: - - twine upload dist/* -r pypitest --repository-url=https://test.pypi.org/legacy/ - - Check that you can install it in a virtualenv/notebook by running: - pip install huggingface_hub fsspec aiohttp - pip install -U tqdm - pip install -i https://testpypi.python.org/pypi evaluate - -6. Upload the final version to actual pypi: - twine upload dist/* -r pypi - -7. Fill release notes in the tag in github once everything is looking hunky-dory. +4. Fill release notes in the tag in github once everything is looking hunky-dory. -8. Change the version in __init__.py and setup.py to X.X.X+1.dev0 (e.g. VERSION=1.18.3 -> 1.18.4.dev0). - Then push the change with a message 'set dev version' +5. Open a PR to change the version in __init__.py and setup.py to X.X.X+1.dev0 (e.g. VERSION=0.4.1 -> 0.4.2.dev0). + Then merge the PR once it's approved. """ import os @@ -158,7 +126,7 @@ setup( name="evaluate", - version="0.4.1", # expected format is one of x.y.z.dev0, or x.y.z.rc1 or x.y.z (no to dashes, yes to dots) + version="0.4.2.dev0", # expected format is one of x.y.z.dev0, or x.y.z.rc1 or x.y.z (no to dashes, yes to dots) description="HuggingFace community-driven open-source library of evaluation", long_description=open("README.md", encoding="utf-8").read(), long_description_content_type="text/markdown", diff --git a/src/evaluate/__init__.py b/src/evaluate/__init__.py index c7ce8f4c4..a4a795ead 100644 --- a/src/evaluate/__init__.py +++ b/src/evaluate/__init__.py @@ -17,7 +17,7 @@ # pylint: enable=line-too-long # pylint: disable=g-import-not-at-top,g-bad-import-order,wrong-import-position -__version__ = "0.4.1" +__version__ = "0.4.2.dev0" from packaging import version