samila/otherfiles/RELEASE.md

Samila Release Instructions

Last Update: 2024-09-04

1. Create the release branch under dev
2. Update all version tags
   1. setup.py
   2. README.md
   3. SECURITY.md
   4. otherfiles/version_check.py
   5. otherfiles/meta.yaml
   6. samila/params.py
   7. examples/demo.ipynb
   8. examples/bulk.ipynb
3. Update CHANGELOG.md
   1. Add a new header under Unreleased section (Example: ## [0.1] - 2022-08-17)
   2. Add a new compare link to the end of the file (Example: [0.2]: https://github.com/sepandhaghighi/samila/compare/v0.1...v0.2)
   3. Update dev compare link (Example: [Unreleased]: https://github.com/sepandhaghighi/samila/compare/v0.2...dev)
4. Update .github/ISSUE_TEMPLATE/bug_report.yml
   1. Add new version tag to Samila version dropbox options
5. Create a PR from release to dev
   1. Title: Version x.x (Example: Version 0.1)
   2. Tag all related issues
   3. Labels: release
   4. Set milestone
   5. Set project
   6. Wait for all CI pass
   7. Need review (1 reviewer)
   8. Squash and merge
   9. Delete release branch
6. Merge dev branch into master
   1. git checkout master
   2. git merge dev
   3. git push origin master
   4. Wait for all CI pass
7. Create a new release
   1. Target branch: master
   2. Tag: vx.x (Example: v0.1)
   3. Title: Version x.x (Example: Version 0.1)
   4. Copy changelogs
   5. Tag all related issues
8. Bump!!
9. Close this version issues
10. Close milestone
11. Close project
12. Update website
    1. git checkout gh-pages
    2. Update all version tags
       1. index.html
    3. Update size of files
       1. index.html
    4. git push origin gh-pages