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* `CITATION.cff` 17 18Additionally, 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. 19 20Use `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. 21 22### Quality control and good citizenry 23 241. 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). 25 262. 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. 27 283. Update and test all the language bindings (see below) within the branch. 29 304. Check that `spack install libceed@develop` works prior to tagging. The Spack `libceed/package.py` file should be updated immediately after tagging a release. 31 32### Tagging and releasing on GitHub 33 340. Confirm all the steps above, including all language bindings. 351. `git commit -am'libCEED 0.8.1'` 36More frequently, this is amending the commit message on an in-progress commit, after rebasing if applicable on latest `main`. 372. `git push` updates the PR holding release; opportunity for others to review 383. `git switch main && git merge --ff-only HEAD@{1}` fast-forward merge into `main` 394. `git tag --sign -m'libCEED 0.8.1'` 405. `git push origin main v0.8.1` 416. Draft a [new release on GitHub](https://github.com/CEED/libCEED/releases), using a few sentences gathered from the release notes. 427. Submit a PR to Spack. 438. Publish Julia, Python, and Rust packages. 44 45### Archive Users Manual on Zenodo 46 47Generate the PDF using `make doc-latexpdf`, click "New version" on the [Zenodo 48record](https://zenodo.org/record/4302737) and upload. Update author info if applicable (new 49authors, or existing authors changing institutions). Make a new PR to update the version 50number and DOI in `README.rst` and `doc/bib/references.bib`. 51 52## Julia 53 54libCEED's Julia interface (LibCEED.jl) has two components: 55 56* LibCEED.jl, the user-facing package that contains the Julia interface. 57* libCEED_jll, a binary wrapper package ("jll package") that contains prebuilt binaries of the 58 libCEED library for various architectures. 59 60When there is a new release of libCEED, both of these components need to be updated. First, 61libCEED_jll is updated, and then LibCEED.jl. 62 63### Updating libCEED_jll 64 65The binary wrapper package libCEED_jll is updated by making a pull request against 66[Yggdrasil](https://github.com/JuliaPackaging/Yggdrasil), the Julia community build tree. In this 67PR, the file `L/libCEED/build_tarballs.jl` should be changed to update version number and change the 68hash of the libCEED commit to use to build the binaries, similar to the following diff: 69```diff 70diff --git a/L/libCEED/build_tarballs.jl b/L/libCEED/build_tarballs.jl 71--- a/L/libCEED/build_tarballs.jl 72+++ b/L/libCEED/build_tarballs.jl 73@@ -3,11 +3,11 @@ 74 using BinaryBuilder, Pkg 75 76 name = "libCEED" 77-version = v"0.7.0" 78+version = v"0.8.0" 79 80 # Collection of sources required to complete build 81 sources = [ 82- GitSource("https://github.com/CEED/libCEED.git", "06988bf74cc6ac18eacafe7930f080803395ba29") 83+ GitSource("https://github.com/CEED/libCEED.git", "e8f234590eddcce2220edb1d6e979af7a3c35f82") 84 ] 85``` 86After the PR is merged into Yggdrasil, the new version of libCEED_jll will automatically be 87registered, and then we can proceed to update LibCEED.jl. 88 89### Updating LibCEED.jl 90 91After the binary wrapper package libCEED_jll has been updated, we are ready to update the main Julia 92interface LibCEED.jl. This requires updating the file `julia/LibCEED.jl/Project.toml` in the libCEED 93repository. The version number should be incremented, and the dependency on the updated version of 94libCEED_jll should be listed: 95```diff 96diff --git a/julia/LibCEED.jl/Project.toml b/julia/LibCEED.jl/Project.toml 97--- a/julia/LibCEED.jl/Project.toml 98+++ b/julia/LibCEED.jl/Project.toml 99@@ -1,7 +1,7 @@ 100 name = "LibCEED" 101 uuid = "2cd74e05-b976-4426-91fa-5f1011f8952b" 102-version = "0.1.0" 103+version = "0.1.1" 104 105 [deps] 106 CEnum = "fa961155-64e5-5f13-b03f-caf6b980ea82" 107@@ -26,4 +26,4 @@ Cassette = "0.3" 108 Requires = "1" 109 StaticArrays = "0.12" 110 UnsafeArrays = "1" 111-libCEED_jll = "0.7" 112+libCEED_jll = "0.8" 113``` 114Once this change is merged into libCEED's `main` branch, the updated package version can be 115registered using the GitHub registrator bot by commenting on the commit: 116 117> @JuliaRegistrator register branch=main subdir=julia/LibCEED.jl 118 119At this point, the bot should create a PR against the [general Julia 120registry](https://github.com/JuliaRegistries/General), which should be merged automatically after a 121short delay. 122 123### Moving development tests to release tests 124 125LibCEED.jl has both _development_ and _release_ unit tests. The _release_ tests are run both with 126the current build of libCEED, and with the most recent release of libCEED_jll. The _development_ 127tests may use features which were not available in the most recent release, and so they are only run 128with the current build of libCEED. 129 130Upon release, the development tests may be moved to the release tests, so that these features will 131be tested against the most recent release of libCEED_jll. The release tests are found in the file 132`julia/LibCEED.jl/test/runtests.jl` and the development tests are found in 133`julia/LibCEED.jl/test/rundevtests.jl`. 134 135## Python 136 137The Python package gets its version from `ceed.pc.template` so there are no file modifications necessary. 138 1391. `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`. 1402. 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. 1413. Create a `~/.pypirc` with entries for `testpypi` (`https://test.pypi.org/legacy/`) and the real `pypi`. 1424. Upload to `testpypi` using 143```console 144$ twine upload --repository testpypi wheelhouse/libceed-0.8-cp39-cp39-manylinux2010_x86_64.whl 145``` 1465. Test installing on another machine/in a virtualenv: 147```console 148$ pip install --index-url https://test.pypi.org/simple --extra-index-url https://pypi.org/simple libceed 149``` 150The `--extra-index-url` argument allows dependencies like `cffi` and `numpy` from being fetched from the non-test repository. 1516. Do it live: 152```console 153$ twine upload --repository pypi wheelhouse/libceed-0.8-cp39-cp39-manylinux2010_x86_64.whl 154``` 155Note that this cannot be amended. 156 157## Rust 158 159The Rust crates for libCEED are split into 1601. [`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) 1612. [`libceed`](https://crates.io/crates/libceed) containing the safe and idiomatic Rust bindings. 162 163We 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. 164 165```console 166$ git grep '0\.8' -- rust/ 167rust/libceed-sys/Cargo.toml:version = "0.8.0" 168rust/libceed-sys/README.md:libceed-sys = "0.8.0" 169rust/libceed-sys/build.rs: .atleast_version("0.8") 170rust/libceed/Cargo.toml:version = "0.8.0" 171rust/libceed/Cargo.toml:libceed-sys = { version = "0.8", path = "../libceed-sys" } 172rust/libceed/README.md:libceed = "0.8.0" 173``` 174 175After doing this, 176 1771. `cargo package --list` to see that the file list makes sense. 1782. `cargo package` to build crates locally 1793. `cargo publish` to publish the crates to https://crates.io 180