RELEASING.md

Release Checklist

Prerelease (several days prior)

• Notify translators of the impending release
• Notify TomH

Prep

• If you don't have a transifex.auth file in the root of your iD checkout, you'll need to create a Transifex account, ask @tyr_asd or @bhousel for admin rights on the iD project, and then create this file with contents like

  { "user":"api", "password": "<your-transifex-api-key>" }

  where you insert your personal transifex api token. This file is not version-controlled and will not be checked in.

Update iD

Update develop branch

$  git checkout develop
$  npm clean-install
$  npm install editor-layer-index
$  npm run imagery
$  npm run all
$  git add . && git commit -m 'npm run imagery'
$  npm run translations
$  git add . && git commit -m 'npm run translations'

• Check and finalize CHANGELOG.md

$  npm version --no-git-tag-version vA.B.C
$  git add . && git commit -m 'vA.B.C'
$  git push origin develop

Update and tag release branch

$  git checkout release
$  git reset --hard develop
$  npm run all
$  git add -f dist
$  git commit -m 'Check in build'
$  git tag vA.B.C
$  git push origin -f release vA.B.C

• Open https://github.com/openstreetmap/iD/tags
• Click ••• –> Create Release, paste version(vA.B.C) to Release title and link to CHANGELOG.md in Describe this release

Prepare develop branch for further development

$  git checkout develop

Add section in CHANGELOG.md for new version number (e.g. # Unreleased (2.28.0-dev)).

$  npm version --no-git-tag-version vAA.BB.0-dev
$  git add . && git commit -m 'Set development version number'
$  git push origin develop

Update openstreetmap-website

Setup remotes (first time only)

$  git remote add osmlab git@github.com:osmlab/openstreetmap-website.git
$  git remote add openstreetmap git@github.com:openstreetmap/openstreetmap-website.git

Sync master branches

$  git fetch --all
$  git checkout master
$  git reset --hard openstreetmap/master
$  git push osmlab master

Create and push branch with the new iD version

$  git checkout -b iD-A.B.C
$  bundle install
$  rm -rf vendor/assets/iD/* && vendorer

• If there have been any changes to iD's URL parameters, make sure they're reflected in app/assets/javascripts/edit/id.js.erb.

$  git add . && git commit -m 'Update to iD vA.B.C'
$  git push osmlab iD-A.B.C

• Open a pull request using the markdown text from the changelog as the comment