1# Release Procedures 2 3*These notes are meant for a maintainer to create official releases.* 4 5In preparing a release, create a branch to hold pre-release commits. We ideally want all release mechanics (for all languages) to be in one commit, which will then be tagged. (This will change if/when we stop synchronizing releases across all language bindings.) 6 7## Core C library 8 9Some minor bookkeeping updates are needed when releasing a new version of the core library. 10 11The version number must be updated in 12 13* `include/ceed/ceed.h` 14* `ceed.pc.template` 15* `Doxyfile` 16 17as well as `include/ceed/ceed.h` (`CEED_VERSION_MAJOR`, `CEED_VERSION_MINOR`). 18 19Additionally, the release notes in `doc/sphinx/source/releasenotes.rst` should be updated. Use `git log --first-parent v0.7..` to get a sense of the pull requests that have been merged and thus might warrant emphasizing in the release notes. While doing this, gather a couple sentences for key features to highlight on [GitHub releases](https://github.com/CEED/libCEED/releases). The "Current Main" heading needs to be named for the release. 20 21Use `make doc-latexpdf` to build a PDF users manual and inspect it for missing references or formatting problems (e.g., with images that were converted to PDF). This contains the same content as the website, but will be archived on Zenodo. 22 23### Quality control and good citizenry 24 251. If making a minor release, check for API and ABI changes that could break [semantic versioning](https://semver.org/). The [ABI compliance checker](https://github.com/lvc/abi-compliance-checker) is a useful tool, as is `nm -D libceed.so` and checking for public symbols (capital letters like `T` and `D` that are not namespaced). 26 272. Double check testing on any architectures that may not be exercised in continuous integration (e.g., HPC facilities) and with users of libCEED, such as MFEM and PETSc applications. While unsupported changes do not prevent release, it's polite to make a PR to support the new release, and it's good for quality to test before taggin a libCEED release. 28 293. Update and test all the language bindings (see below) within the branch. 30 314. Check that `spack install libceed@develop` works prior to tagging. The Spack `libceed/package.py` file should be updated immediately after tagging a release. 32 33### Tagging and releasing on GitHub 34 350. Confirm all the steps above, including all language bindings. 361. `git commit -am'libCEED 0.8.1'` 37More frequently, this is amending the commit message on an in-progress commit, after rebasing if applicable on latest `main`. 382. `git push` updates the PR holding release; opportunity for others to review 393. `git switch main && git merge --ff-only HEAD@{1}` fast-forward merge into `main` 404. `git tag --sign -m'libCEED 0.8.1'` 415. `git push origin main v0.8.1` 426. Draft a [new release on GitHub](https://github.com/CEED/libCEED/releases), using a few sentences gathered from the release notes. 437. Submit a PR to Spack. 448. Publish Julia, Python, and Rust packages. 45 46### Archive Users Manual on Zenodo 47 48Generate the PDF using `make doc-latexpdf`, click "New version" on the [Zenodo 49record](https://zenodo.org/record/4302737) and upload. Update author info if applicable (new 50authors, or existing authors changing institutions). Make a new PR to update the version 51number and DOI in `README.rst` and `doc/bib/references.bib`. 52 53## Julia 54 55libCEED's Julia interface (LibCEED.jl) has two components: 56 57* LibCEED.jl, the user-facing package that contains the Julia interface. 58* libCEED_jll, a binary wrapper package ("jll package") that contains prebuilt binaries of the 59 libCEED library for various architectures. 60 61When there is a new release of libCEED, both of these components need to be updated. First, 62libCEED_jll is updated, and then LibCEED.jl. 63 64### Updating libCEED_jll 65 66The binary wrapper package libCEED_jll is updated by making a pull request against 67[Yggdrasil](https://github.com/JuliaPackaging/Yggdrasil), the Julia community build tree. In this 68PR, the file `L/libCEED/build_tarballs.jl` should be changed to update version number and change the 69hash of the libCEED commit to use to build the binaries, similar to the following diff: 70```diff 71diff --git a/L/libCEED/build_tarballs.jl b/L/libCEED/build_tarballs.jl 72--- a/L/libCEED/build_tarballs.jl 73+++ b/L/libCEED/build_tarballs.jl 74@@ -3,11 +3,11 @@ 75 using BinaryBuilder, Pkg 76 77 name = "libCEED" 78-version = v"0.7.0" 79+version = v"0.8.0" 80 81 # Collection of sources required to complete build 82 sources = [ 83- GitSource("https://github.com/CEED/libCEED.git", "06988bf74cc6ac18eacafe7930f080803395ba29") 84+ GitSource("https://github.com/CEED/libCEED.git", "e8f234590eddcce2220edb1d6e979af7a3c35f82") 85 ] 86``` 87After the PR is merged into Yggdrasil, the new version of libCEED_jll will automatically be 88registered, and then we can proceed to update LibCEED.jl. 89 90### Updating LibCEED.jl 91 92After the binary wrapper package libCEED_jll has been updated, we are ready to update the main Julia 93interface LibCEED.jl. This requires updating the file `julia/LibCEED.jl/Project.toml` in the libCEED 94repository. The version number should be incremented, and the dependency on the updated version of 95libCEED_jll should be listed: 96```diff 97diff --git a/julia/LibCEED.jl/Project.toml b/julia/LibCEED.jl/Project.toml 98--- a/julia/LibCEED.jl/Project.toml 99+++ b/julia/LibCEED.jl/Project.toml 100@@ -1,7 +1,7 @@ 101 name = "LibCEED" 102 uuid = "2cd74e05-b976-4426-91fa-5f1011f8952b" 103-version = "0.1.0" 104+version = "0.1.1" 105 106 [deps] 107 CEnum = "fa961155-64e5-5f13-b03f-caf6b980ea82" 108@@ -26,4 +26,4 @@ Cassette = "0.3" 109 Requires = "1" 110 StaticArrays = "0.12" 111 UnsafeArrays = "1" 112-libCEED_jll = "0.7" 113+libCEED_jll = "0.8" 114``` 115Once this change is merged into libCEED's `main` branch, the updated package version can be 116registered using the GitHub registrator bot by commenting on the commit: 117 118> @JuliaRegistrator register branch=main subdir=julia/LibCEED.jl 119 120At this point, the bot should create a PR against the [general Julia 121registry](https://github.com/JuliaRegistries/General), which should be merged automatically after a 122short delay. 123 124### Moving development tests to release tests 125 126LibCEED.jl has both _development_ and _release_ unit tests. The _release_ tests are run both with 127the current build of libCEED, and with the most recent release of libCEED_jll. The _development_ 128tests may use features which were not available in the most recent release, and so they are only run 129with the current build of libCEED. 130 131Upon release, the development tests may be moved to the release tests, so that these features will 132be tested against the most recent release of libCEED_jll. The release tests are found in the file 133`julia/LibCEED.jl/test/runtests.jl` and the development tests are found in 134`julia/LibCEED.jl/test/rundevtests.jl`. 135 136## Python 137 138The Python package gets its version from `ceed.pc.template` so there are no file modifications necessary. 139 1401. `make wheel` builds and tests the wheels using Docker. See the [manylinux repo](https://github.com/pypa/manylinux) for source and usage inforamtion. If this succeeds, the completed wheels are in `wheelhouse/libceed-0.8-cp39-cp39-manylinux2010_x86_64.whl`. 1412. Manually test one or more of the wheels by creating a virtualenv and using `pip install wheelhouse/libceed-0.8-cp39-cp39-manylinux2010_x86_64.whl`, then `python -c 'import libceed'` or otherwise running tests. 1423. Create a `~/.pypirc` with entries for `testpypi` (`https://test.pypi.org/legacy/`) and the real `pypi`. 1434. Upload to `testpypi` using 144```console 145$ twine upload --repository testpypi wheelhouse/libceed-0.8-cp39-cp39-manylinux2010_x86_64.whl 146``` 1475. Test installing on another machine/in a virtualenv: 148```console 149$ pip install --index-url https://test.pypi.org/simple --extra-index-url https://pypi.org/simple libceed 150``` 151The `--extra-index-url` argument allows dependencies like `cffi` and `numpy` from being fetched from the non-test repository. 1526. Do it live: 153```console 154$ twine upload --repository pypi wheelhouse/libceed-0.8-cp39-cp39-manylinux2010_x86_64.whl 155``` 156Note that this cannot be amended. 157 158## Rust 159 160The Rust crates for libCEED are split into 1611. [`libceed-sys`](https://crates.io/crates/libceed-sys), which handles building/finding the `libceed.so` or `libceed.a` library and providing unsafe Rust bindings (one to one with the C interface, using C FFI datatypes) 1622. [`libceed`](https://crates.io/crates/libceed) containing the safe and idiomatic Rust bindings. 163 164We currently apply the same version number across both of these crates. There are some tests for version strings matching, but in short, one needs to update the following locations. 165 166```console 167$ git grep '0\.8' -- rust/ 168rust/libceed-sys/Cargo.toml:version = "0.8.0" 169rust/libceed-sys/README.md:libceed-sys = "0.8.0" 170rust/libceed-sys/build.rs: .atleast_version("0.8") 171rust/libceed/Cargo.toml:version = "0.8.0" 172rust/libceed/Cargo.toml:libceed-sys = { version = "0.8", path = "../libceed-sys" } 173rust/libceed/README.md:libceed = "0.8.0" 174``` 175 176After doing this, 177 1781. `cargo package --list` to see that the file list makes sense. 1792. `cargo package` to build crates locally 1803. `cargo publish` to publish the crates to https://crates.io 181