2.x Release Procedure

mstenta · January 19, 2022, 6:56pm

This documents the standard procedure for packaging a new release of farmOS 2.x. It is used as a checklist by the maintainers to ensure that all the necessary steps are taken.

(A similar document was maintained for farmOS 1.x here: Release procedure - farmOS.org)

Confirm:
- Drupal core and pinned modules are up-to-date
- 2.x branch build is successful
Release:
- Create “farmOS [version]” commit (eg: farmOS 2.0.0-beta2 · farmOS/farmOS@2b76832 · GitHub)
  - Update CHANGELOG.md with new version and release date
- Tag new version
- Push 2.x and tag to origins
- Wait for GitHub Actions to create release
- Create release node in drupal.org (eg: farm 2.0.0-beta2 | Drupal.org)
  - Copy text from github release
  - Link to GitHub release for tarball
Announce:
- Chat
- Forum (eg: farmOS 2.0.0-beta2 has been released)
- OpenCollective (eg: farmOS 2.0.0-beta2 has been released - Open Collective)
- Mastodon & Twitter (automated via farmOS-microblog)

mstenta · April 7, 2022, 6:28pm

mstenta · April 7, 2022, 6:32pm

mstenta · April 7, 2022, 6:45pm

Similarly, here is the standard procedure for releases of farmOS-map:

Confirm all dependencies are up-to-date
Create a “Release v[version]” commit (eg: Release v2.0.3 · farmOS/farmOS-map@6d25f8f · GitHub)
- Update CHANGELOG.md with new version and release date
- Update version in package.json (line 3) and package-lock.json (lines 3 and 9)
Tag new version (e.g. git tag v9000.0.1)
Push 2.x and tag to origin (e.g. git push --atomic origin HEAD:2.x v9000.0.1)
Update the farmOS-map library version in farmOS (line 10 and 13 of composer.libraries.json: farmOS/composer.libraries.json at 5c764c5b50f4d9404e7b20012d29a1f188506994 · farmOS/farmOS · GitHub)