README-hosted-maintenance.markdown

Mender Docs hosted branch maintenance

hosted is the only branch in mender-docs repository that we update from master. Whereas the rest of the release branches are branched out at some point in time from master, and not updated again (except for bugfix releases or minor text fixes), the hosted branch is a "live" branch that gets frequent merges from master.

Procedure

To update hosted branch:

1. Create a new branch from hosted

For example:

git fetch origin hosted:hosted-update-$(date --iso-8601)
git checkout hosted-update-$(date --iso-8601)

2. Merge in master and resolve conflicts

git merge origin/master
<fix conflicts>
git add <files>
git commit -s

There are two main cases where conflicts are expected in hosted branch:

Latest versions of the Mender components

In hosted the versions for all Mender components are set to latest stable release, while for master are master. Therefore these conflicts are resolved by taking master "text" with hosted "versions".

08.Server-installation and 201.Troubleshoot/Mender-Server

These sections are completely overridden in hosted branch, so conflicts are resolved here by choosing "our" version.

3. Run ./autoversion.py --update and commit the changes

To update version references of any incoming text from master, run autoversion.py tool using latest versions. For example:

./autoversion.py --update --integration-dir <local-dir> \
      --integration-version staging \
      --mender-convert-version 2.1.0 \
      --mender-convert-client-version 2.3.0 \
      --meta-mender-version dunfell \
      --poky-version dunfell \
      --mender-binary-delta-version 1.1.0

4. Launch a PR and ask for review

The pull request shall target hosted branch. The main things to look for in the review are:

• References to Mender components' versions are correct.
• 08.Server-installation and 201.Troubleshoot/Mender-Server sections have the overridden content.