Skip to content

Versioning Releases wiith Rever #1186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 2 additions & 75 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,76 +1,3 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]

# C extensions
*.so

# Distribution / packaging
.Python
env/
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
*.egg-info/
.installed.cfg
*.egg

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.coverage
.coverage.*
.cache
coverage.xml
*,cover

# Translations
*.mo
*.pot

# Django stuff:
*.log

# Sphinx documentation
docs/_build/

# PyBuilder
target/

# PyCharm
.idea

# Jupyter
.ipynb_checkpoints/

# setuptools-scm
zarr/version.py

# emacs
*~

# test data
#*.zarr
#*.zip
#example*
#doesnotexist
#test_sync*
data/*
# Rever
rever/
13 changes: 13 additions & 0 deletions rever.xsh
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
$PROJECT = 'zarr'

$ACTIVITIES = ['version_bump']

$VERSION_BUMP_PATTERNS = [ # These note where/how to find the version numbers
('zarr/version.py', r'__version__\s*=.*', "__version__ = '$VERSION'"),
('setup.py', r'version\s*=.*,', "version='$VERSION',")
]
Comment on lines +5 to +8
Copy link
Contributor

@Saransh-cpp Saransh-cpp Oct 15, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, is this manually bumping Zarr's version? Remember, Zarr uses VCS to generate versions. This means that -

  1. zarr/version.py technically does not exist. It is an autogenerated file, which is generated by setuptools_scm using the git tags available in Zarr's git repository. We should not be editing this autogenerated file manually. Whenever a new git tag is created in Zarr, setuptools_scm automatically picks it up and bumps Zarr's version.
  2. setup.py specifies using a VCS version using the use_scm_version argument in setup. Hence, there are no "version" variables that have to be updated in setup.py.

TL;DR: We should not be manually bumping Zarr's version.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for the review.




$GITHUB_ORG = 'zarr' # Github org for Github releases and conda-forge
$GITHUB_REPO = 'zarr-python' # Github repo for Github releases and conda-forge