diff --git a/RELEASING.md b/RELEASING.md index 6439d3053..30d82bf0b 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -9,9 +9,11 @@ - 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 @bhousel for admin rights on the iD project, and then create this file with contents like
-     {"user": "yourusername", "password": "*******"}
+ {"user": "yourusername", "password": "*******"}This file is not version-controlled and will not be checked in. + +### Update `iD` -### Update master branch +#### Update `master` branch ```bash $ git checkout master $ rm -rf node_modules/editor-layer-index/ @@ -21,13 +23,17 @@ $ npm run all $ git add . && git commit -m 'npm run imagery' $ npm run translations $ git add . && git commit -m 'npm run translations' -$ Update `CHANGELOG.md` -$ Update version number in `modules/core/context.js`, `package.json` +``` + +- Update `CHANGELOG.md` +- Update version number in `modules/core/context.js`, `package.json` + +```bash $ git add . && git commit -m 'vA.B.C' $ git push origin master ``` -### Update and tag release branch +#### Update and tag `release` branch ```bash $ git checkout release $ git reset --hard master @@ -36,27 +42,34 @@ $ git add -f dist/*.css dist/*.js dist/img/*.svg dist/mapillary-js/ dist/pannel $ 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 "Add Release Notes" and link to the CHANGELOG ``` +- Open https://github.com/openstreetmap/iD/tags +- Click `•••` –> `Create Release` and link to `CHANGELOG.md` in `Describe this release` -### Update openstreetmap-website +### Update `openstreetmap-website` -#### Setup remotes (one time only) +#### Setup remotes (first time only) ```bash $ git remote add osmlab git@github.com:osmlab/openstreetmap-website.git $ git remote add upstream git@github.com:openstreetmap/openstreetmap-website.git ``` -#### Sync master and update iD (every time) +#### Sync master branches + ```bash $ git fetch --all $ git checkout master $ git reset --hard upstream/master +$ git push origin master +``` + +#### Create and push branch with the new iD version + +```bash $ git checkout -b iD-A.B.C $ bundle install $ rm -rf vendor/assets/iD/* && vendorer $ git add . && git commit -m 'Update to iD vA.B.C' $ git push osmlab - Open pull request ``` +- Open a pull request using the markdown text from the changelog as the description \ No newline at end of file