Skip to content

Update 0.3.3 - #496

Merged
skim0119 merged 4 commits into
masterfrom
update-0.3.3
Aug 29, 2025
Merged

Update 0.3.3#496
skim0119 merged 4 commits into
masterfrom
update-0.3.3

Conversation

@skim0119

@skim0119 skim0119 commented Aug 25, 2025

Copy link
Copy Markdown
Collaborator

Release Checklist

  • Final check README and CONTRIBUTING.
  • Bump LICENSE year
  • Bump version
    • Bump version for dependabot
  • Dependency version (uv update)
    • Might break some dependency chain.

Test

  • Run the tests
  • Run the formatting
  • CI Check
python -m pytest
make all

Setup.py

  • Update version number in setup.py (or version.py) (can also be minor or major)
  • Check if we need to upgrade REQUIRES_PYTHON or REQUIRED dependencies.
  • Check if local installation can be done.
  • Update download_url in setup
conda create --name temp
conda activate temp
conda install python==<version>
which pip
pip install .

Documentation and Website

  • Check all documentations are updated
  • Update version label on documentation
    • docs/conf.py
    • Python version
  • Update version label on website
    • Python version
- BEYOND THIS, EACH STEP SHOULD BE DONE IN SERIAL (STEP_BY_STEPS). -

Last Edit

  • Rebase the commit history (should be done by only one person) right before the PR. (Not required)

Update

  1. Merge the branch to master
  2. Release on PyPI by uploading python setup.py upload (make sure twine is installed)
  3. Release on github (v) "include v in front"

Update Release Note

  • Update RELEASE.md - It should be in based on milestone description.
  • Commit the changes:
git add RELEASE.md
git commit -m "Changelog for upcoming release <version>"

Final Check

  • Test that it pip installs
  • Check the PyPI listing page to make sure that the README, release notes, and roadmap display properly.

@skim0119 skim0119 self-assigned this Aug 25, 2025
@skim0119 skim0119 added bug Something isn't working update Update the codebase prio:high Priority level: high dependencies Pull requests that update a dependency file labels Aug 25, 2025
@skim0119 skim0119 added this to the Version 0.3.3 milestone Aug 25, 2025
@skim0119
skim0119 requested review from Ali-7800 and sy-cui August 26, 2025 02:09

@Ali-7800 Ali-7800 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM

Comment thread README.md Outdated
Comment thread elastica/interaction.py

@sy-cui sy-cui left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Minor comment. Otherwise LGTM.

Comment thread .github/workflows/main.yml Outdated
Comment thread docs/advanced/PackageDesign.md Outdated
@skim0119
skim0119 merged commit aef9e24 into master Aug 29, 2025
18 checks passed
@skim0119
skim0119 deleted the update-0.3.3 branch August 29, 2025 15:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working dependencies Pull requests that update a dependency file prio:high Priority level: high update Update the codebase

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants