Use integer schema version numbers #688
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vyasr
requested review from
b-butler and
Charlottez112
and removed request for
a team
Codecov Report
@@ Coverage Diff @@
## schema2 #688 +/- ##
===========================================
- Coverage 86.29% 86.28% -0.01%
===========================================
Files 52 52
Lines 5042 5040 -2
Branches 1102 1101 -1
===========================================
- Hits 4351 4349 -2
Misses 489 489
Partials 202 202
Continue to review full report at Codecov.
|
bdice
approved these changes
Feb 24, 2022
Co-authored-by: Bradley Dice <bdice@bradleydice.com>
vyasr
added a commit
that referenced
this pull request
Mar 14, 2022
* Change schema versioning to use integer strings. * Switch from int strings to pure ints. * Update signac/contrib/migration/__init__.py Co-authored-by: Bradley Dice <bdice@bradleydice.com> Co-authored-by: Bradley Dice <bdice@bradleydice.com>
vyasr
added a commit
that referenced
this pull request
Apr 14, 2022
* Change schema versioning to use integer strings. * Switch from int strings to pure ints. * Update signac/contrib/migration/__init__.py Co-authored-by: Bradley Dice <bdice@bradleydice.com> Co-authored-by: Bradley Dice <bdice@bradleydice.com>
vyasr
added a commit
that referenced
this pull request
Apr 19, 2022
* Change schema versioning to use integer strings. * Switch from int strings to pure ints. * Update signac/contrib/migration/__init__.py Co-authored-by: Bradley Dice <bdice@bradleydice.com> Co-authored-by: Bradley Dice <bdice@bradleydice.com>
vyasr
added a commit
that referenced
this pull request
Apr 19, 2022
* Initial migration to schema version 2 including config rename (#678) * Implement initial migration to schema version 2. * Require project-local config to be signac.rc (not .signacrc) and make searches stricter to match. * Standardize method for getting project config at a root. * Move config to .signac/config. * Fix import order. * Address PR comments. * Remove some unnecessary code. * Address final PR coments. * Use integer schema version numbers (#688) * Change schema versioning to use integer strings. * Switch from int strings to pure ints. * Update signac/contrib/migration/__init__.py Co-authored-by: Bradley Dice <bdice@bradleydice.com> Co-authored-by: Bradley Dice <bdice@bradleydice.com> * Remove project name from schema (#684) * Remove project id API. * Remove project name from config as part of migration. * Fix issues with config CLI and remove project from default cfg. * Address PR comments. * Change the str of a project to the str of its root directory. * Change Project constructor to use root directory (#706) * Change project constructor to accept a root directory instead of a config file. * Change Project repr. * Address easy PR comments. * Move internal signac files into .signac subdirectory (#708) * Move shell history. * Move sp_cache file. * Address PR comments. * Move discovery to separate functions. (#711) * Move discovery to separate functions. * Address first round of PR comments. * Address PR comments. * Apply suggestions. * Remove configurable workspace directory (#714) * Remove workspace configurability. * Implement workspace_dir migration. * Apply suggestions from code review Co-authored-by: Bradley Dice <bdice@bradleydice.com> * Address remaining PR comments. * Update tests/test_project.py * Remove mention of configurability from project workspace docstring * Address PR comments. Co-authored-by: Bradley Dice <bdice@bradleydice.com> Co-authored-by: Corwin Kerr <cbkerr@umich.edu> * Update description of schema migration. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci Co-authored-by: Bradley Dice <bdice@bradleydice.com> Co-authored-by: Corwin Kerr <cbkerr@umich.edu> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
vyasr
added a commit
that referenced
this pull request
Apr 21, 2022
* Change schema versioning to use integer strings. * Switch from int strings to pure ints. * Update signac/contrib/migration/__init__.py Co-authored-by: Bradley Dice <bdice@bradleydice.com> Co-authored-by: Bradley Dice <bdice@bradleydice.com>
vyasr
added a commit
that referenced
this pull request
May 2, 2022
* Change schema versioning to use integer strings. * Switch from int strings to pure ints. * Update signac/contrib/migration/__init__.py Co-authored-by: Bradley Dice <bdice@bradleydice.com> Co-authored-by: Bradley Dice <bdice@bradleydice.com>
bdice
added a commit
that referenced
this pull request
Jun 14, 2022
* Change schema versioning to use integer strings. * Switch from int strings to pure ints. * Update signac/contrib/migration/__init__.py Co-authored-by: Bradley Dice <bdice@bradleydice.com> Co-authored-by: Bradley Dice <bdice@bradleydice.com>
bdice
added a commit
that referenced
this pull request
Aug 1, 2022
* Change schema versioning to use integer strings. * Switch from int strings to pure ints. * Update signac/contrib/migration/__init__.py Co-authored-by: Bradley Dice <bdice@bradleydice.com> Co-authored-by: Bradley Dice <bdice@bradleydice.com>
bdice
added a commit
that referenced
this pull request
Oct 7, 2022
* Change schema versioning to use integer strings. * Switch from int strings to pure ints. * Update signac/contrib/migration/__init__.py Co-authored-by: Bradley Dice <bdice@bradleydice.com> Co-authored-by: Bradley Dice <bdice@bradleydice.com>
bdice
added a commit
that referenced
this pull request
Oct 27, 2022
* Change schema versioning to use integer strings. * Switch from int strings to pure ints. * Update signac/contrib/migration/__init__.py Co-authored-by: Bradley Dice <bdice@bradleydice.com> Co-authored-by: Bradley Dice <bdice@bradleydice.com>
vyasr
added a commit
that referenced
this pull request
Oct 30, 2022
* Change schema versioning to use integer strings. * Switch from int strings to pure ints. * Update signac/contrib/migration/__init__.py Co-authored-by: Bradley Dice <bdice@bradleydice.com> Co-authored-by: Bradley Dice <bdice@bradleydice.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR changes schema versioning to use a integer version numbers rather than semantic versioning-style strings.
Motivation and Context
Version strings as used to denote different "levels" of changes are not really applicable to schema. There is no concept of a patch, and while in principle we could make backwards compatible minor changes in practice we only anticipate major-like changes. Switching to this scheme will avoid presenting this extra complexity as we introduce further migrations, and as a bonus it simplifies our internal migration logic. #684 contains more information.
Types of Changes
1The change breaks (or has the potential to break) existing functionality.
Checklist:
If necessary: