Improve the release workflow #3737

Saransh-cpp · 2024-01-16T19:47:10Z

Description

Fixes # (issue)

Type of change

Please add a line in the relevant section of CHANGELOG.md to document the change (include PR #) - note reverse order of PR #s. If necessary, also add to the list of breaking changes.

New feature (non-breaking change which adds functionality)
Optimization (back-end change that speeds up the code)
Bug fix (non-breaking change which fixes an issue)

Key checklist:

No style issues: $ pre-commit run (or $ nox -s pre-commit) (see CONTRIBUTING.md for how to set this up to run automatically when committing locally, in just two lines of code)
All tests pass: $ python run-tests.py --all (or $ nox -s tests)
The documentation builds: $ python run-tests.py --doctest (or $ nox -s doctests)

You can run integration tests, unit tests, and doctests together at once, using $ python run-tests.py --quick (or $ nox -s quick).

Further checks:

Code is commented, particularly in hard-to-understand areas
Tests added that prove fix is effective or that feature works

Saransh-cpp · 2024-01-16T19:48:14Z

.github/workflows/update_version.yml

+      # create a pull request updating versions in develop
+      - name: Create Pull Request
+        id: version_pr
+        uses: peter-evans/create-pull-request@v3
+        with:


Now we don't "sync" the release and develop branches, instead we just update the versions in both the branches independently. This saves us from the conflicts and duplicating the cherry-picked commits.

Saransh-cpp · 2024-01-16T19:48:48Z

scripts/update_version.py

+    release_date = (
+        date.today()
+        if "rc" in release_version
+        else date.today() + relativedelta(day=31)
+    )


The final release will be at the end of the month, but the rc releases will be in between.

Not all months have 31 days

This always returns the last day of the month. The current workflows use the same line and it can be seen that the headings in the CHANGELOG are correct for months that don't have 31 days.

Saransh-cpp · 2024-01-16T19:50:09Z

scripts/update_version.py

+        # add a new heading for rc0 releases
        if "rc0" in release_version:
            output_list.insert(2, changelog_line2)
        else:
-            output_list[2] = changelog_line2
+            # for rcX and final releases, update the already existing rc
+            # release heading
+            for i in range(0, len(output_list)):
+                if re.search("[v]\d\d\.\drc\d", output_list[i]):


For rc0 release, we just need to add a new heading under the "Unreleased" heading. But, for rcX and final releases, the workflow now finds the existing "rc" heading and replaces it with an updated version and date.

codecov · 2024-01-16T20:05:50Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (59eb517) 99.59% compared to head (851d378) 99.59%.
Report is 6 commits behind head on develop.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #3737   +/-   ##
========================================
  Coverage    99.59%   99.59%           
========================================
  Files          258      258           
  Lines        20798    20811   +13     
========================================
+ Hits         20713    20726   +13     
  Misses          85       85

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

arjxn-py

The further comments you made clears most of my doubts and as i've also noticed & observed #3736, this looks good to me.

* Try fixing the release workflow * Turn off safety * Fix CHANGELOG * Add OS * Use regex for better matches * Update instructions, add safety checks * checkout to the version branch for the final release

* Bump to v23.9rc0 * Merge pull request #3412 from agriyakhetarpal/drop-i686-manylinux2014-support Drop support for i686 manylinux * Merge pull request #3413 from Saransh-cpp/improve-release-workflow Improve release workflow, add a note, bump version manually * Merge pull request #3436 from Saransh-cpp/fortnightly-wheels Build wheels on the 1st and 15th of every month * Merge pull request #3445 from pybamm-team/issue-3428-rename-exchange #3428 exchange-current density error * Merge pull request #3449 from pybamm-team/i3431-windows-wheels Fix failing windows wheel builds * Merge pull request #3456 from abillscmu/issue-3224-initial_soc make initial soc work with half cell models * Merge pull request #3467 from abillscmu/bugfix/initial_soh * Merge pull request #3423 from jsbrittain/jax_gpu JaxSolver fails when using GPU support with no input parameters * Fix changelog * Merge pull request #3475 from arjxn-py/fix-default-imports Resolve default imports for optional dependencies * Bump - `v23.9rc1` * Fix date in CHANGELOG * Bump version to v23.9 * Fix docs about Jax solver compatibility with Python versions (#3702) * Ensure correct Python versions for Jax solver compatibility * Simplify array of Python versions Co-authored-by: Eric G. Kratz <[email protected]> * Use different conjunction Co-authored-by: Eric G. Kratz <[email protected]> --------- Co-authored-by: Eric G. Kratz <[email protected]> * Merge pull request #3706 from agriyakhetarpal/fix-pybamm-install-odes Make `pybamm_install_odes` a bit more robust * #3690 fix issue with skipped steps (#3708) * #3690 fix issue with skipped steps * #3690 changelog * #3690 add test * #3611 use actual cell volume for average total heating (#3707) * #3611 use actual cell volume for average total heating * #3611 changelog * #3611 account for number of electrode pairs * #3611 update variable names * Improve the release workflow (#3737) * Try fixing the release workflow * Turn off safety * Fix CHANGELOG * Add OS * Use regex for better matches * Update instructions, add safety checks * checkout to the version branch for the final release * Bump to v24.1rc1 * #3630 fix interpolant shape error (#3761) * #3630 fix interpolant shape error * #3630 changelog * Bump to v24.1rc2 * Bump to v24.1 * Fix doctests failures in scheduled tests (#3784) Closes #3781 * Resolve broken `scikits.odes` installation on self-hosted M-series runner (#3785) * Try fixing M-series runner tests This is being done by adding SuiteSparse and SUNDIALS installations which might have been missing on the runner, which broke `scikits.odes`. * Don't use Homebrew SUNDIALS, use LD_LIBRARY_PATH * Don't use Homebrew to install SUNDIALS * Force remove pip cache for `scikits.odes` --------- Co-authored-by: Eric G. Kratz <[email protected]> * add temperature dependence to MSMR model * changelog * fix tests * fix example * rob comments * update notebook --------- Co-authored-by: Ferran Brosa Planella <[email protected]> Co-authored-by: Saransh Chopra <[email protected]> Co-authored-by: Martin Robinson <[email protected]> Co-authored-by: Agriya Khetarpal <[email protected]> Co-authored-by: Eric G. Kratz <[email protected]> Co-authored-by: Robert Timms <[email protected]> Co-authored-by: Saransh-cpp <[email protected]>

* Try fixing the release workflow * Turn off safety * Fix CHANGELOG * Add OS * Use regex for better matches * Update instructions, add safety checks * checkout to the version branch for the final release

* Bump to v23.9rc0 * Merge pull request pybamm-team#3412 from agriyakhetarpal/drop-i686-manylinux2014-support Drop support for i686 manylinux * Merge pull request pybamm-team#3413 from Saransh-cpp/improve-release-workflow Improve release workflow, add a note, bump version manually * Merge pull request pybamm-team#3436 from Saransh-cpp/fortnightly-wheels Build wheels on the 1st and 15th of every month * Merge pull request pybamm-team#3445 from pybamm-team/issue-3428-rename-exchange pybamm-team#3428 exchange-current density error * Merge pull request pybamm-team#3449 from pybamm-team/i3431-windows-wheels Fix failing windows wheel builds * Merge pull request pybamm-team#3456 from abillscmu/issue-3224-initial_soc make initial soc work with half cell models * Merge pull request pybamm-team#3467 from abillscmu/bugfix/initial_soh * Merge pull request pybamm-team#3423 from jsbrittain/jax_gpu JaxSolver fails when using GPU support with no input parameters * Fix changelog * Merge pull request pybamm-team#3475 from arjxn-py/fix-default-imports Resolve default imports for optional dependencies * Bump - `v23.9rc1` * Fix date in CHANGELOG * Bump version to v23.9 * Fix docs about Jax solver compatibility with Python versions (pybamm-team#3702) * Ensure correct Python versions for Jax solver compatibility * Simplify array of Python versions Co-authored-by: Eric G. Kratz <[email protected]> * Use different conjunction Co-authored-by: Eric G. Kratz <[email protected]> --------- Co-authored-by: Eric G. Kratz <[email protected]> * Merge pull request pybamm-team#3706 from agriyakhetarpal/fix-pybamm-install-odes Make `pybamm_install_odes` a bit more robust * pybamm-team#3690 fix issue with skipped steps (pybamm-team#3708) * pybamm-team#3690 fix issue with skipped steps * pybamm-team#3690 changelog * pybamm-team#3690 add test * pybamm-team#3611 use actual cell volume for average total heating (pybamm-team#3707) * pybamm-team#3611 use actual cell volume for average total heating * pybamm-team#3611 changelog * pybamm-team#3611 account for number of electrode pairs * pybamm-team#3611 update variable names * Improve the release workflow (pybamm-team#3737) * Try fixing the release workflow * Turn off safety * Fix CHANGELOG * Add OS * Use regex for better matches * Update instructions, add safety checks * checkout to the version branch for the final release * Bump to v24.1rc1 * pybamm-team#3630 fix interpolant shape error (pybamm-team#3761) * pybamm-team#3630 fix interpolant shape error * pybamm-team#3630 changelog * Bump to v24.1rc2 * Bump to v24.1 * Fix doctests failures in scheduled tests (pybamm-team#3784) Closes pybamm-team#3781 * Resolve broken `scikits.odes` installation on self-hosted M-series runner (pybamm-team#3785) * Try fixing M-series runner tests This is being done by adding SuiteSparse and SUNDIALS installations which might have been missing on the runner, which broke `scikits.odes`. * Don't use Homebrew SUNDIALS, use LD_LIBRARY_PATH * Don't use Homebrew to install SUNDIALS * Force remove pip cache for `scikits.odes` --------- Co-authored-by: Eric G. Kratz <[email protected]> * add temperature dependence to MSMR model * changelog * fix tests * fix example * rob comments * update notebook --------- Co-authored-by: Ferran Brosa Planella <[email protected]> Co-authored-by: Saransh Chopra <[email protected]> Co-authored-by: Martin Robinson <[email protected]> Co-authored-by: Agriya Khetarpal <[email protected]> Co-authored-by: Eric G. Kratz <[email protected]> Co-authored-by: Robert Timms <[email protected]> Co-authored-by: Saransh-cpp <[email protected]>

Saransh-cpp added 7 commits January 16, 2024 20:18

Try fixing the release workflow

f44bce5

Merge branch 'pybamm-team:develop' into develop

0fa9ca4

Turn off safety

8023fdf

Fix CHANGELOG

520ddab

Add OS

4e0c8c0

Use regex for better matches

2198ad7

Update instructions, add safety checks

b60690a

Saransh-cpp commented Jan 16, 2024

View reviewed changes

checkout to the version branch for the final release

851d378

Saransh-cpp requested review from agriyakhetarpal, arjxn-py and kratman January 16, 2024 19:51

arjxn-py approved these changes Jan 17, 2024

View reviewed changes

Saransh-cpp merged commit f22c2bc into pybamm-team:develop Jan 17, 2024
38 of 41 checks passed

Saransh-cpp deleted the improve-release-workflow branch January 17, 2024 10:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve the release workflow #3737

Improve the release workflow #3737

Saransh-cpp commented Jan 16, 2024

Saransh-cpp Jan 16, 2024

Saransh-cpp Jan 16, 2024

kratman Jan 16, 2024

Saransh-cpp Jan 16, 2024

Saransh-cpp Jan 16, 2024 •

edited

Loading

codecov bot commented Jan 16, 2024

arjxn-py left a comment

Improve the release workflow #3737

Improve the release workflow #3737

Conversation

Saransh-cpp commented Jan 16, 2024

Description

Type of change

Key checklist:

Further checks:

Saransh-cpp Jan 16, 2024

Choose a reason for hiding this comment

Saransh-cpp Jan 16, 2024

Choose a reason for hiding this comment

kratman Jan 16, 2024

Choose a reason for hiding this comment

Saransh-cpp Jan 16, 2024

Choose a reason for hiding this comment

Saransh-cpp Jan 16, 2024 • edited Loading

Choose a reason for hiding this comment

codecov bot commented Jan 16, 2024

Codecov Report

arjxn-py left a comment

Choose a reason for hiding this comment

Saransh-cpp Jan 16, 2024 •

edited

Loading