Prepare for 2.0.0 release #193
Merged
+22
−25
Conversation
This file contains hidden or 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
All YAML functionality was deprecated in 1.2.0 and removed in 2.0.0. Signed-off-by: John Pennycook <[email protected]>
Signed-off-by: John Pennycook <[email protected]>
Signed-off-by: John Pennycook <[email protected]>
Signed-off-by: John Pennycook <[email protected]>
- Update version and DOI for 2.0.0 release. - Add Kelvin Lee as an author to reflect his contributions. Signed-off-by: John Pennycook <[email protected]>
There was a problem hiding this comment.
Pull Request Overview
This PR prepares the project for a major 2.0.0 release by updating dependency versions, the minimum required Python version, and version numbers across documentation and citation files.
- Removed unused dependencies and updated dependency versions in pyproject.toml
- Updated version numbers in docs/source/conf.py and README.md
- Revised citation metadata in CITATION.cff, including adding an author and updating the release date and DOI
Reviewed Changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| pyproject.toml | Updated Python requirement and dependency versions |
| docs/source/conf.py | Updated version and release strings to 2.0.0 |
| README.md | Updated release version references and branch name in clone command |
| CITATION.cff | Updated citation metadata with new version, release date, DOI, and added author |
Files not reviewed (1)
- docs/source/index.rst: Language not supported
Comments suppressed due to low confidence (3)
pyproject.toml:15
- Ensure that updating the minimum required Python version to 3.12 is fully compatible with all production components and documented in the release notes.
requires-python = ">=3.12"
pyproject.toml:27
- Review the major version bump for NumPy to ensure that this update does not introduce compatibility issues with other dependencies or production code.
"numpy==2.2.4"
CITATION.cff:18
- Confirm that the release date is accurate before merging; update it to reflect the actual release date if needed.
date-released: "2025-05-15"
laserkelvin
approved these changes
May 15, 2025
docs/source/index.rst
Outdated
| release, run the following:: | ||
|
|
||
| $ git clone --branch 1.2.0 https://github.com/intel/code-base-investigator.git | ||
| $ git clone --branch 2.0.0 https://github.com/intel/code-base-investigator.git |
There was a problem hiding this comment.
Do you want to roll this into a single step for users?
pip install git+https://github.com/intel/[email protected]Unless you're developing CBI, I don't think this omits anything from the workflow?
There was a problem hiding this comment.
That's much better. I've made this change in 827911f, for both the README and the docs. I left it in expanded form for the example showing how to install it in a virtual environment.
Signed-off-by: John Pennycook <[email protected]>
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.
Related issues
N/A
Proposed changes
I set the date field to today, but I suspect the release will actually happen at some point in the next few days. I'll need to update that immediately prior to the merge, but everything else can be reviewed now.