From 0507b44606e0b0ae76b8e60813486e4322a0086c Mon Sep 17 00:00:00 2001 From: Julian Simioni Date: Sat, 20 Oct 2018 08:15:26 -0400 Subject: [PATCH] fix(install): Update documentation to use master branches We are in the process of deprecating the staging/production branches. The first step is to keep the documentation up to date and ensure people switch as soon as possible. Connects https://github.com/pelias/pelias/issues/749 --- pelias_from_scratch.md | 24 +++--------------------- 1 file changed, 3 insertions(+), 21 deletions(-) diff --git a/pelias_from_scratch.md b/pelias_from_scratch.md index 7ee066f..0bf536e 100644 --- a/pelias_from_scratch.md +++ b/pelias_from_scratch.md @@ -83,38 +83,20 @@ At a minimum, you'll need Here's a bash snippet that will download all the repositories (they are all small enough that you don't -have to worry about the space of the code itself), check out the production branch (which is -probably the one you want), and install all the node module dependencies. +have to worry about the space of the code itself) and install all the node module dependencies. ```bash for repository in schema whosonfirst geonames openaddresses openstreetmap polylines api placeholder interpolation pip-service; do git clone https://github.com/pelias/${repository}.git # clone from Github pushd $repository > /dev/null # switch into importer directory - git checkout production # or remove this line to stay with master npm install # install npm dependencies popd > /dev/null # return to code directory done ``` -
- Not sure which branch to use? - -Pelias uses three diferent branches as part of our release process. - -`production` **(recommended)**: contains only code that has been well tested, generally against a -full-planet build. This is the "safest" branch and it will change the least frequently, although we -generally release new code at least once a week. - -`staging`: these branches contain the code that is currently being tested against a full planet -build for imminent release. It's useful to track what code will be going out in the next release, -but not much else. - -`master`: master branches contain the latest code that has passed code review, unit/integration -tests, and is reasonably functional. While we try to avoid it, the nature of the master branch is -that it will sometimes be broken. That said, these are the branches to use for development of new -features. -
+**Note:** Pelas used to use `production` branches for stable development. The +master branch is [now used for that purpose](https://github.com/pelias/pelias/issues/749). ### Customize Pelias Config