Skip to content

Commit b87b235

Browse files
committed
Update RELEASE.md (#3166)
1 parent bfd825b commit b87b235

1 file changed

Lines changed: 30 additions & 27 deletions

File tree

RELEASE.md

Lines changed: 30 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Check that all CIs on `main` are running green.
99
Check that the `main` documentation looks reasonable at
1010
https://docs.fenicsproject.org.
1111

12-
The release proceeds in a bottom up manner (Basix, UFL, FFCx, DOLFINx). pypa
12+
The release proceeds in a bottom up manner (UFL, Basix, FFCx, DOLFINx). pypa
1313
packages cannot be deleted and should be made a number of days after the
1414
creation of git tags so that errors can be fixed. GitHub releases can have their
1515
version notes updated, and can be deleted and remade on new tags (not recommended).
@@ -31,9 +31,25 @@ bumped an entire minor version i.e. `0.+1.0`.
3131

3232
UFL still runs on the year-based release scheme.
3333

34+
### UFL version bump
35+
36+
1. Merge `origin/main` into `release` resolving all conflicts in favour of `main`.
37+
38+
git pull
39+
git checkout release
40+
git merge --no-commit origin/main
41+
git checkout --theirs origin/main . # files deleted on `main` must be manually git `add`ed
42+
git diff origin/main
43+
44+
2. Update the version number in `pyproject.toml`, e.g. `2022.2.0`.
45+
46+
3. Commit and push.
47+
48+
4. Check `git diff origin/main` for obvious errors.
49+
3450
### Basix version bump
3551

36-
1. Merge `main` into `release` resolving all conflicts in favour of `main`.
52+
1. Merge `origin/main` into `release` resolving all conflicts in favour of `main`.
3753

3854
git pull
3955
git checkout release
@@ -52,22 +68,6 @@ UFL still runs on the year-based release scheme.
5268

5369
6. Check `git diff origin/main` for obvious errors.
5470

55-
### UFL version bump
56-
57-
1. Merge `main` into `release` resolving all conflicts in favour of `main`.
58-
59-
git pull
60-
git checkout release
61-
git merge --no-commit main
62-
git checkout --theirs origin/main . # files deleted on `main` must be manually git `add`ed
63-
git diff main
64-
65-
2. Update the version number in `pyproject.toml`, e.g. `2022.2.0`.
66-
67-
3. Commit and push.
68-
69-
4. Check `git diff origin/main` for obvious errors.
70-
7171
### FFCx version bump
7272

7373
1. Merge `main` into `release` resolving all conflicts in favour of `main`.
@@ -179,7 +179,7 @@ Use the *Docker update stable* tag workflow to update/link `:stable` to e.g.
179179

180180
https://github.com/FEniCS/dolfinx/actions/workflows/docker-update-stable.yml
181181

182-
### pypa
182+
### pypi
183183

184184
Wheels can be made using the following actions:
185185

@@ -192,8 +192,8 @@ https://github.com/FEniCS/ffcx/actions/workflows/build-wheels.yml
192192
Both the workflow and the ref should be set to the appropriate tags for each
193193
component.
194194

195-
It is recommended to first build without publishing, then to test pypa, then to
196-
the real pypa. Publishing to pypa cannot be revoked.
195+
It is recommended to first build without publishing, then to test pypi, then to
196+
the real pypi. Publishing to pypa cannot be revoked.
197197

198198
The DOLFINx wheel builder is experimental and is not used in the release
199199
process at this time.
@@ -208,12 +208,12 @@ release process you can either:
208208

209209
2. Manually make commits on the `release` branch.
210210

211-
If you want the change to be reflected on `main` long term 1. is preferred.
211+
If you want the same change to be reflected on `main` option 1. is preferred.
212212

213213
If a mistake is noticed soon after making a tag then you can delete the tag and
214-
recreate it. It is also possible to recreate GitHub releases. After pypa
215-
packages are pushed you must create .post0 tags or make minor version bumps, as
216-
pypa is immutable.
214+
recreate it. It is also possible to recreate GitHub releases. However, if the
215+
mistake was noticed after pypi packages are pushed you must create `*.post0`
216+
tags or make a minor version bumps , as pypa is immutable.
217217

218218
### GitHub releases
219219

@@ -236,10 +236,13 @@ Check for any changes on `release` that should be cherry-picked back onto
236236

237237
git checkout main
238238
git diff release
239+
git log
240+
git cherry-pick 914ae4
239241

240-
Bump the version numbers on the `main` branch via a PR.
242+
Bump the version numbers on the `main` branches of UFL, Basix, FFCx,
243+
DOLFINx following the instructions above.
241244

242-
## Bug fix patches
245+
### Bug fix patches
243246

244247
Bug fix versions e.g. `v0.5.1` can be made by cherry picking commits off of
245248
`main` and bumping the minor version number. Remember to run the DOLFINx

0 commit comments

Comments
 (0)