Skip to content
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.

Sign up for GitHub

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

Jump to bottom

BOUT++ v5.0.0 release candidate #2604

Merged
merged 3,842 commits into from
Feb 8, 2023
Merged

BOUT++ v5.0.0 release candidate #2604

merged 3,842 commits into from
Feb 8, 2023

Conversation

ZedThree
Copy link
Member

@ZedThree ZedThree commented Nov 2, 2022 •
edited

A truly monumental PR -- BOUT++ v5 is almost here!

See changelog for list of changes. Still lots of maintainer things to do:

  • 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:

  • Update locale translation files
    • make -C locale update-all
    • Be aware that this will update the timestamps and possibly
      reorder file paths in the .po and .pot files
  • Update [CHANGELOG.md][changelog]:
    • Install github_changelog_generator
      • Make sure it is at least v1.15!
    • Run like make changelog LAST_VERSION=vA.B.C RELEASE_BRANCH=master|next
      • See the docs for how to get the token
      • RELEASE_BRANCH might need to be the RC branch to get
        bugfix PRs
    • Check [CHANGELOG.md][changelog]!
      • Remove duplicate header/footer
      • Replace extraneous escaping: \(\)
  • Get list of authors:
    • git log --format='%aN' | sort | uniq
    • Compare to list in CITATION.cff, add new authors
  • Prep a new Zenodo release:
  • Change DOI in CITATION.cff to new DOI
  • Change DOI in [README.md][README.md] to new DOI
  • Change date-released in CITATION.cff
  • Check abidiff to see if soname needs bumping in makefile:
  • Change version number, removing prerelease tag in:

After PR is merged:

  • Make tarball: ./configure && make dist
  • Try to summarise the changes!
  • Make GitHub Release, include change summary NB: tag should have
    leading v
  • Upload tarball to GitHub Release
  • Upload tarball to Zenodo and publish new version
  • Email BOUT++ User Group mailing list, include change summary
  • Make news post on project website, include change summary
  • Update downloads page
  • PR master into next
  • Bump version number and add prerelease tag in:

ZedThree and others added 30 commits July 28, 2022 15:16
@ZedThree
Docs: Explain some common CMake options
790f744 
Fixes #2558
@ZedThree
Docs: Update Ubuntu instructions
19c4bcb
@ZedThree
Docs: Fix some whitespace
0a5ce80
@ZedThree
Docs: Remove outdated note
d55a05c
@ZedThree
Docs: Fix some xBout links
d354528
@ZedThree
Docs: Fix some broken tables
2869dfb
@ZedThree
Docs: Fix some formatting issues
5340246
@ZedThree
Fully remove deprecated Field3D.background
f310418 
Fixes #2543

Was deprecated in #448, and `Field3D.setBackground` was removed in #2291.
This removes the private member and all uses of it
@ZedThree
Merge branch 'next' into pcr_thomas
255a7c0 
* next: (1519 commits)
  Remove some useless forward declarations
  Revert "Remove some unused headers from vecops"
  Remove some unused headers from vecops
  Fix bad merge: missed removing extraneous `const` on return value
  Remove `Up/DownXSplitIndex`
  Remove last remaining uses of `deprecated.hxx`
  Apply clang-format
  Apply clang-format changes
  CI: Don't update submodules (already updated)
  CI: Workaround for git ownership checks in container
  CI: Bump actions/checkout version
  CI: Use latest version of cmake in clang-tidy-review
  Use MPI_COMM_NULL rather than nullptr
  Add 'u' format flag to BOUT.settings output
  Adds a 'u' format, commenting unused options
  Apply clang-format changes
  Apply clang-format changes
  Don't compile LaplaceXY2 with 3D metrics
  Apply clang-format changes
  Apply clang-format changes
  ...
@ZedThree
Fix LaplacePCR_THOMAS constructor for new Laplace parameters
eb23e43
@ZedThree
Fix type of Coordinates::zlength/dz in Laplace PCR Thomas
e1609d3
@ZedThree
Remove duplicated header in Laplace PCR Thomas
50be150
@ZedThree
Fix some clang-tidy suggestions in PCR Thomas
442ace2 
- implicit narrowing conversion
- C-style array
- loop variable name too short
- multiple declarations on same line
- dead stores
@ZedThree
Apply clang-format
571130f
@ZedThree
Remove two unused private ShiftedMetric::shiftz overloads
adefdf8 
Closes #1437
@ZedThree
Merge pull request #2340 from boutproject/pcr_thomas
8c6968b 
Add PCR Thomas Laplacian inversion solver
@ZedThree
Merge pull request #2564 from boutproject/cmake-docs
32afc20 
Improve CMake docs
@ZedThree
Remove LaplacePDD implementation
b0bbe3b 
Closes #1828
@ZedThree
Add tool to move headers under include/bout and fix #includes
44e6a7f 
Replaces similar bash tool
@bendudson
Merge pull request #2567 from boutproject/remove-laplace-pdd
59db39b 
Remove `LaplacePDD` implementation
@bendudson
Merge pull request #2565 from boutproject/remove-fields-background
563d669 
Fully remove deprecated `Field3D.background`
@bendudson
Change unbalanced brackets check
db0d990 
Rather than checking if the count is odd, check if there are more
opening brackets than closing.
@ZedThree
Merge pull request #2571 from boutproject/options-multiline
1707893 
Change unbalanced brackets check
@johnomotani
Correct docs about value of x in input file expressions
7595589 
[skip ci]
@johnomotani
Documentation on value of y in input file expressions
cfc4c40 
[skip ci]
@johnomotani
Replace slightly-incorrect comment in BoutMesh::GlobalY()
79e71af 
[skip ci]
@johnomotani
Add cross-ref in input expressions docs to defn of x,y,z
2d4b93d 
[skip ci]
@dschwoerer
Add requires for FFTW to tests
9cba2f5 
Several test require (optional) FFTW. Skip those if FFTW is not present.
@ZedThree
Merge pull request #2578 from boutproject/update-initial-conditions-docs
08101c9 
Correct and add missing info to docs for x/y/z values in input file expressions
@ZedThree
Merge pull request #2579 from boutproject/fftw_test_skip
7bc1834 
Add requires for FFTW to tests
@ZedThree
Copy link
Member Author

ZedThree commented Feb 3, 2023

I think I need to turn off the clang-format/tidy workflows on protected branches

@ZedThree
Merge pull request #2636 from boutproject/fix-laplace-datafile
1885260 
Fix use of removed `Datafile` in `Laplacian` constructor; update docs
@ZedThree
Copy link
Member Author

ZedThree commented Feb 3, 2023 •
edited

Ok last few things to do:

  • Make sure version is correct everywhere
  • DOI
  • manually run clang-format

@ZedThree ZedThree closed this Feb 3, 2023
@ZedThree ZedThree reopened this Feb 3, 2023
@ZedThree
Copy link
Member Author

ZedThree commented Feb 3, 2023

Ok, all v5.0 PRs merged, housekeeping done -- after almost 5 years, v5 is ready to launch! Release is scheduled for Wednesday the 8th.

The CI is going to show this as failing because the clang-format and clang-tidy actions don't like this branch (protected, so can't push, and way too many files, respectively)

@bendudson
Copy link
Contributor

Thank you @ZedThree! And thanks to everyone who has volunteered their time and effort to work on this open source effort. There is still work to do, but I think we can all be proud of what we've created.

@ZedThree
Copy link
Member Author

ZedThree commented Feb 3, 2023

Broken :( Fix incoming though

@bendudson
Copy link
Contributor

:( Somewhat ironic. Seems to be something PETSc-related.

ZedThree and others added 5 commits February 3, 2023 18:00
@ZedThree
Workaround PETSc clobbering MPI functions with its macros
cd4538c 
One of the clang-format patches rearranged some headers... and it
turns out PETSc helpfully clobbers some MPI functions with its own
macros for reasons, and this interferes with our `MpiWrapper` class.

Some files had `#undef` some of these macros, but rearranging headers
left some exposed.

This instead defines a macro in the `PetscLib` header that should stop
PETSc defining the MPI macros in the first place. We just need to make
sure that all PETSc headers are `#include`d _after_ our `PetscLib`
@bendudson
Merge pull request #2637 from boutproject/fix-petsc-mpi-defines
8b50840 
Workaround PETSc clobbering MPI functions with its macros
@dschwoerer
Provide overloaded virtual function also in derived class
47fd00a 
This avoids a warning in recent gcc
@ZedThree
Merge pull request #2653 from boutproject/output-warning
b1d285d 
Provide overloaded virtual function also in derived class
@ZedThree
Update changelog
779ed3c
@ZedThree ZedThree merged commit d935fa1 into master Feb 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@ZedThree @bendudson @dschwoerer @johnomotani