TurbulenceConvection.jl
TurbulenceConvection.jl copied to clipboard
How to patch the prognostic theta version of TC.jl (v0.27) - Haakon's guide
- The branch you should merge changes to is called
theta-var
. When creating PRs, remember to specify the target branch astheta-var
. - The test suite seems to run as expected, see: #1046, a PR that proposes a fix to
theta-var
. - When tagging a new release, add a commit to
theta-var
through a PR where you update the root Project.toml with the new version, e.g. version = "0.27.1" (see this commit as an example). - To register the new version in Julia’s Register, either:
- Go to the JuliaHub Web Interface (log in with GitHub) and fill in the details. Note: under Tag/Branch specify theta-var (see attached screenshot for an example).
- Add a comment to the version-update commit, with
@JuliaRegistrator register branch=theta-var
(note: I haven’t tested this, but should work according to their docs). See attached screenshot for an example. - Check the status of the PR that registers the new version here.
I followed this procedure to register v0.27.1 (a test release that updates some dependencies), and after this PR was merged in ~10 minutes, I was able to install the new version in a local directory using add TurbulenceConvection. After all this is done (and only after), I can create a git tag and GitHub Release. This isn’t actually needed (the package is already registered in Julia), but I guess is good for reproducibility etc. There’s a TagBot that should do this, but I’m not sure if it works on custom branches (or how to use it in general). So I just created a tag manually from the command line: git tag -a v0.27.1 -m "patch release for calibration" then git push origin v0.27.1. Then a release by clicking Releases on the TC.jl main page > Draft a new release. I stole the Release notes from the format of previous release notes. link.
Error while trying to register: "Tag with name v0.27.1
already exists and points to a different commit"