-
Notifications
You must be signed in to change notification settings - Fork 196
prepare release #1337
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
Merged
Merged
prepare release #1337
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
File renamed without changes.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# Preparing a release | ||
|
||
## Decide what will be the upcoming version number | ||
|
||
- `sbi` currently uses the [Semver 2.0.0](https://semver.org/) convention. | ||
- Edit the version number in the tuple at `sbi/sbi/__version__.py`. | ||
|
||
## Collect a list of relevant changes | ||
|
||
- [ ] Edit `changelog.md`: Add a new version number header and report changes below it. | ||
|
||
Trick: To get a list of all changes since the last PR, you can start creating a | ||
release via GitHub already (https://github.com/sbi-dev/sbi/releases, see below), add a | ||
tag and then let GitHub automatically draft the release notes. Note that some changes | ||
might not be worth mentioning, or others might be missing or needing more explanation. | ||
- [ ] Use one line per change, include links to the pull requests that implemented each of | ||
the changes. | ||
- [ ] **Credit contributors**! | ||
- [ ] If there are new package dependencies or updated version constraints for the existing | ||
dependencies, add/modify the corresponding entries in `pyproject.toml`. | ||
- [ ] Test the installation in a fresh conda env to make sure all dependencies match. | ||
|
||
## Run tests locally and make sure they pass | ||
|
||
- Run the **full test suite, including slow tests.** | ||
- [ ] slow tests are passing | ||
- [ ] GPU tests are passing | ||
|
||
## Upload to pypi | ||
|
||
The upload to `pypi` will happen automatically once a release is made | ||
via GitHub. | ||
|
||
To do so, **after merging this PR**, you need to | ||
|
||
- [ ] copy the new content you added to `changelog.md` to the clipboard | ||
- [ ] draft a new release here: https://github.com/sbi-dev/sbi/releases | ||
- [ ] create a new tag using the `vX.XX.X` scheme | ||
- [ ] paste the content of the `changelog` you copied above and edit it where needed | ||
- [ ] select "pre-release" if needed (default no) or "latest release" (default yes) | ||
- [ ] select "create a discussion" if there are breaking or important changes and users | ||
should have a platform to discuss issues and questions. | ||
- [ ] "publish" or "draft" the release. | ||
|
||
Once the release is *published* via Github, the upload to PyPi will be triggered. |
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
# This file is part of sbi, a toolkit for simulation-based inference. sbi is licensed | ||
# under the Apache License Version 2.0, see <https://www.apache.org/licenses/> | ||
|
||
VERSION = (0, 23, 2) | ||
VERSION = (0, 23, 3) | ||
|
||
__version__ = ".".join(map(str, VERSION)) |
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.