5.1 release candidate #2720

ZedThree · 2023-06-14T17:03:46Z

We've got into a bit of mess between master and next, and I don't have a great deal of time to sort it out, so the simplest thing is to get everything into master and release 5.1.

New and currently open PRs into next should target this branch now.

Making a New Release of BOUT++

This is checklist of things to do (in order) when making a new
release. This applies equally to both major/minor releases and bugfix
releases

Check there are no open issues/PRs for this milestone
- Fix or bump to next version
Make a branch named vX.Y.Z-rc
- The GitHub repo is setup to protect branches named in this style
- Major and minor release points (X/Y) should be off
  next. Bugfix releases (Z) should be off master
Make pull request into master
- Any new bugfixes should be PRs into the RC branch, where
  "bugfixes" can include:
  - silencing warnings
  - improving documentation
  - adding tests
Run make check-all
- Raise issues for any tests that fail
Possibly run clang-tidy, clang-check, coverity, etc.
Review pinned pip package versions for Travis

Before merging PR:

After PR is merged:

We need to link with gcov to get gcda files. Further, they are in the build directories, not the source directories.

Co-authored-by: Peter Hill <[email protected]>

* support sudo without password * set actually a password * Use --build-args rather then bash script to generate Dockerfile

* next: (517 commits) Apply clang-format Fix some clang-tidy suggestions in PCR Thomas Remove duplicated header in Laplace PCR Thomas Fix type of `Coordinates::zlength/dz` in Laplace PCR Thomas Fix `LaplacePCR_THOMAS` constructor for new Laplace parameters Docs: Fix some formatting issues Docs: Fix some broken tables Docs: Fix some xBout links Docs: Remove outdated note Docs: Fix some whitespace Docs: Update Ubuntu instructions Docs: Explain some common CMake options Docs: Add a short quickstart guide with basic instructions Docs: Move and expand section on building examples/models with CMake Docs: Whitespace cleanup Docs: Expand basic CMake docs Docs: Note that configure is deprecated Docs: Remove out-dated note Docs: Use `https` instead of `git` protocol Remove some useless forward declarations ...

Remove h5py - we only support netcdf

Improving compatibility with fmt 10

github-actions

clang-tidy made some suggestions

include/bout/petsclib.hxx

github-actions · 2023-07-26T16:11:47Z

include/bout/petsclib.hxx

@@ -111,6 +115,14 @@ public:
   */
  static void cleanup();

+  static inline void assertIerr(PetscErrorCode ierr, std::string op = "PETSc operation") {


warning: the parameter 'op' is copied for each invocation but only used as a const reference; consider making it a const reference [performance-unnecessary-value-param]

Suggested change

static inline void assertIerr(PetscErrorCode ierr, std::string op = "PETSc operation") {

static inline void assertIerr(PetscErrorCode ierr, const std::string& op = "PETSc operation") {

github-actions · 2023-07-26T16:11:47Z

include/bout/petsclib.hxx

@@ -111,6 +115,14 @@ public:
   */
  static void cleanup();

+  static inline void assertIerr(PetscErrorCode ierr, std::string op = "PETSc operation") {


warning: parameter name 'op' is too short, expected at least 3 characters [readability-identifier-length]

static inline void assertIerr(PetscErrorCode ierr, std::string op = "PETSc operation") { ^

github-actions · 2023-07-26T16:11:47Z

include/bout/petsclib.hxx

@@ -111,6 +115,14 @@ public:
   */
  static void cleanup();

+  static inline void assertIerr(PetscErrorCode ierr, std::string op = "PETSc operation") {
+    if (ierr) {


warning: implicit conversion 'PetscErrorCode' (aka 'int') -> bool [readability-implicit-bool-conversion]

Suggested change

if (ierr) {

if (ierr != 0) {

github-actions · 2023-07-26T16:11:47Z

src/sys/petsclib.cxx

@@ -135,4 +124,17 @@ void PetscLib::setPetscOptions(Options& options, const std::string& prefix) {
    }
  }
 }
+
+BoutException PetscLib::SNESFailure(SNES& snes) {
+  SNESConvergedReason reason;


warning: variable 'reason' is not initialized [cppcoreguidelines-init-variables]

SNESConvergedReason reason; ^

github-actions · 2023-07-26T16:11:47Z

src/sys/petsclib.cxx

+  SNESConvergedReason reason;
+  BOUT_DO_PETSC(SNESGetConvergedReason(snes, &reason));
+#if PETSC_VERSION_GE(3, 15, 0)
+  const char* message;


warning: variable 'message' is not initialized [cppcoreguidelines-init-variables]

Suggested change

const char* message;

const char* message = nullptr;

Fix FV::Div_a_Grad_perp Y alignment

Update RELEASE_HOWTO.md

ZedThree · 2023-09-22T10:18:05Z

I think this is essentially all the maintenance tasks done and we're ready to go @bendudson

The Fedora tests are still failing, but that is an issue with either Fedora or Github.

ZedThree · 2023-09-22T10:26:55Z

The python package CI are all failing, I guess because it's looking for a tag 5.1.0 which doesn't exist yet.

dschwoerer · 2023-09-22T13:27:55Z

Yes, the python package only needs bumping after the release.

If the release is a tag, it should "do the right thing" :-)

bendudson

Thanks @ZedThree

[skip ci]

dschwoerer and others added 30 commits February 28, 2022 13:34

Build containers in GHA CI

0732af0

Ensure we found a parallel SUNDIALS

2b11fca

Workaround for finding SUNDIALS

7d98f8e

Switching tests to CMake

1dbebcf

add debug

7f54be1

Avoid adding netcdf to flags

8277875

Cleanup tests

28999d7

debug

f53770d

Fix static linking for petsc

7b73f39

Run only unit tests for coverage

c480555

Set sundials LD_LIBRARY_PATH

6628bb5

Fix coverage job

f5cdabf

CI: Install fastcov

d3c5ffa

try lcov for coverage

995151d

fix coverage for cmake

02bd701

We need to link with gcov to get gcda files. Further, they are in the build directories, not the source directories.

Merge branch 'next' of https://github.com/boutproject/BOUT-dev into HEAD

f4d7607

Tidy up messages

5864e7f

Co-authored-by: Peter Hill <[email protected]>

Improve docker CI

d903927

* support sudo without password * set actually a password * Use --build-args rather then bash script to generate Dockerfile

Only generate if file is executable

eb7f84a

CI: Nicer name for builds

9a330ab

Add deprecation warning to configure

2b43271

Merge branch 'next' into ci-cmake-only

aa23f56

Merge remote-tracking branch 'origin/next' into ci-cmake-only

bd73ab7

make tarball after bumping version

b73414e

switch some docs to cmake

a407a86

Switch advanced install to cmake

7765700

Update recommendet PETSc

48daf16

Update installing to cmake

98edf23

3D metrics user switched away from configure

9d6de34

dschwoerer and others added 10 commits July 3, 2023 00:13

Use new ierr checker

4f0abf0

Explicitly cast to int for fmt10

cfd091d

Static cast also for printing

8bc3943

Add missing include

323ded4

Add missing include

4418065

SNESGetConvergedReasonString was introduced only in PETSc 3.15

784b8d0

Apply clang-format changes

0f0a354

Remove h5py - we only support netcdf

f95c277

Merge pull request #2735 from boutproject/no-h5py

6082b4a

Remove h5py - we only support netcdf

Merge pull request #2730 from boutproject/fmt10

9c22f24

Improving compatibility with fmt 10

github-actions bot reviewed Jul 26, 2023

View reviewed changes

bendudson added 2 commits August 6, 2023 10:22

Merge branch 'v5.1.0-rc' into bugfix-fvops-yalign

f5b352a

Merge pull request #2722 from boutproject/bugfix-fvops-yalign

2e4fdbf

Fix FV::Div_a_Grad_perp Y alignment

dschwoerer mentioned this pull request Sep 13, 2023

Allow static builds with Sundials #2740

Merged

dschwoerer added 2 commits September 13, 2023 10:18

Update RELEASE_HOWTO.md

70c808e

Merge branch 'v5.1.0-rc' into dschwoerer-patch-1

fce2e70

bendudson mentioned this pull request Sep 14, 2023

WIP: Adios io #2739

Closed

bendudson and others added 6 commits September 14, 2023 13:43

Merge pull request #2741 from boutproject/dschwoerer-patch-1

9e734c9

Update RELEASE_HOWTO.md

Maint: Update changelog

a24a359

Maint: Update translation files

0c4d702

Maint: Bump version to v5.1.0

ac5e5d5

Maint: Add Tom Chapman to citation file

0e41029

Maint: Update DOI

4adda14

bendudson previously approved these changes Oct 2, 2023

View reviewed changes

Maint: Update release date

8ae5e35

[skip ci]

ZedThree dismissed bendudson’s stale review via 8ae5e35 October 4, 2023 16:00

ZedThree merged commit 2e3cc2c into master Oct 4, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

5.1 release candidate #2720

5.1 release candidate #2720

ZedThree commented Jun 14, 2023 •

edited

Loading

github-actions bot left a comment

github-actions bot Jul 26, 2023

github-actions bot Jul 26, 2023

github-actions bot Jul 26, 2023

github-actions bot Jul 26, 2023

github-actions bot Jul 26, 2023

ZedThree commented Sep 22, 2023

ZedThree commented Sep 22, 2023

dschwoerer commented Sep 22, 2023

bendudson left a comment

	static inline void assertIerr(PetscErrorCode ierr, std::string op = "PETSc operation") {
	static inline void assertIerr(PetscErrorCode ierr, const std::string& op = "PETSc operation") {

5.1 release candidate #2720

5.1 release candidate #2720

Conversation

ZedThree commented Jun 14, 2023 • edited Loading

Making a New Release of BOUT++

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot Jul 26, 2023

Choose a reason for hiding this comment

github-actions bot Jul 26, 2023

Choose a reason for hiding this comment

github-actions bot Jul 26, 2023

Choose a reason for hiding this comment

github-actions bot Jul 26, 2023

Choose a reason for hiding this comment

github-actions bot Jul 26, 2023

Choose a reason for hiding this comment

ZedThree commented Sep 22, 2023

ZedThree commented Sep 22, 2023

dschwoerer commented Sep 22, 2023

bendudson left a comment

Choose a reason for hiding this comment

ZedThree commented Jun 14, 2023 •

edited

Loading