3.x Release Procedure

[mstenta]

This documents the standard procedure for packaging a new release of farmOS 3.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
  • 3.x branch build is successful
• Release:
  • Create “farmOS [version]” commit (eg: farmOS 3.1.0 · farmOS/farmOS@96bf17b · GitHub)
    • Update CHANGELOG.md with new version and release date
  • Tag new version
  • Push 3.x and tag to origins
  • Wait for GitHub Actions to create release
  • Create release node in drupal.org (eg: https://www.drupal.org/project/farm/releases/3.1.0)
    • Copy text from github release
    • Link to GitHub release for tarball
• Announce:
  • All releases:
    • Chat (automated via irc.farmos.org)
    • Forum (automated via GitHub Actions)
    • Mastodon (automated via farmOS-microblog)
  • Major and minor releases:
    • Blog (eg: farmOS 3.1.0 | farmOS)
    • Newsletter (copied from blog, eg: farmOS 3.1.0 has been released! 🌱🎉 • Buttondown)
    • OpenCollective (eg: farmOS 3.1.0 has been released! 🎉 - Open Collective)

[mstenta]

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

• Confirm all dependencies are up-to-date (i.e. npm audit fix and create a commit with changes)
• 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)