Update docs
This commit is contained in:
parent
b508689b53
commit
8487e4fb52
@ -1,8 +1,8 @@
|
|||||||
1. Test (make clean all check), fix if broken before proceeding
|
1. Test (make clean all check), fix if broken before proceeding
|
||||||
2. Ensure proper version in package.json
|
2. Ensure proper version in package.json and package-lock.json
|
||||||
3. Ensure NEWS section exists for the new version, review it, add release date
|
3. Ensure NEWS section exists for the new version, review it, add release date
|
||||||
4. If there are modified dependencies in package.json, update them with `yarn upgrade {{package_name}}@{{version}}`
|
4. If there are modified dependencies in package.json, update them with `npm upgrade {{package_name}}@{{version}}`
|
||||||
5. Commit package.json, yarn.lock, NEWS
|
5. Commit package.json, package-lock.json (or yarn.lock), NEWS
|
||||||
6. git tag -a Major.Minor.Patch # use NEWS section as content
|
6. git tag -a Major.Minor.Patch # use NEWS section as content
|
||||||
7. Stub NEWS/package for next version
|
7. Stub NEWS/package for next version
|
||||||
|
|
||||||
|
14
INSTALL.md
14
INSTALL.md
@ -4,8 +4,8 @@
|
|||||||
Make sure that you have the requirements needed. These are
|
Make sure that you have the requirements needed. These are
|
||||||
|
|
||||||
- Core
|
- Core
|
||||||
- Node.js >=6.9.x
|
- Node >= 10.14.2 or 6.9.2
|
||||||
- yarn >=0.27.5 <1.0.0
|
- npm >= 6.4.1 or yarn >= 0.27.5
|
||||||
- PostgreSQL >8.3.x, PostGIS >1.5.x
|
- PostgreSQL >8.3.x, PostGIS >1.5.x
|
||||||
- Redis >2.4.0 (http://www.redis.io)
|
- Redis >2.4.0 (http://www.redis.io)
|
||||||
- Mapnik >3.x. See [Installing Mapnik](https://github.com/CartoDB/Windshaft#installing-mapnik).
|
- Mapnik >3.x. See [Installing Mapnik](https://github.com/CartoDB/Windshaft#installing-mapnik).
|
||||||
@ -42,12 +42,18 @@ psql -d template_postgis -c 'CREATE EXTENSION postgis;'
|
|||||||
|
|
||||||
To fetch and build all node-based dependencies, run:
|
To fetch and build all node-based dependencies, run:
|
||||||
|
|
||||||
|
- Node.js >= 10.14.2:
|
||||||
|
```shell
|
||||||
|
npm ci
|
||||||
```
|
```
|
||||||
|
|
||||||
|
- Node.js 6.9.2:
|
||||||
|
```shell
|
||||||
yarn
|
yarn
|
||||||
```
|
```
|
||||||
|
|
||||||
Note that the ```yarn``` step will populate the node_modules/
|
Note that the ```npm``` (or ```yarn```) step will populate the node_modules/
|
||||||
directory with modules, some of which being compiled on demand. If you
|
directory with modules, some of which being compiled on demand. If you
|
||||||
happen to have startup errors you may need to force rebuilding those
|
happen to have startup errors you may need to force rebuilding those
|
||||||
modules. At any time just wipe out the node_modules/ directory and run
|
modules. At any time just wipe out the node_modules/ directory and run
|
||||||
```yarn``` again.
|
```npm``` again.
|
||||||
|
3
NEWS.md
3
NEWS.md
@ -3,6 +3,9 @@
|
|||||||
## 6.5.2
|
## 6.5.2
|
||||||
Released 2018-mm-dd
|
Released 2018-mm-dd
|
||||||
|
|
||||||
|
Announcements:
|
||||||
|
- Update docs: compatible Node.js and npm versions
|
||||||
|
|
||||||
|
|
||||||
## 6.5.1
|
## 6.5.1
|
||||||
Released 2018-12-26
|
Released 2018-12-26
|
||||||
|
18
README.md
18
README.md
@ -31,8 +31,16 @@ Upgrading
|
|||||||
|
|
||||||
Checkout your commit/branch. If you need to reinstall dependencies (you can check [NEWS](NEWS.md)) do the following:
|
Checkout your commit/branch. If you need to reinstall dependencies (you can check [NEWS](NEWS.md)) do the following:
|
||||||
|
|
||||||
|
- Node.js >= 10.14.2:
|
||||||
|
```sh
|
||||||
|
$ rm -rf node_modules
|
||||||
|
$ npm install
|
||||||
```
|
```
|
||||||
rm -rf node_modules; yarn
|
|
||||||
|
- Node.js 6.9.2:
|
||||||
|
```
|
||||||
|
$ rm -rf node_modules
|
||||||
|
$ yarn
|
||||||
```
|
```
|
||||||
|
|
||||||
Run
|
Run
|
||||||
@ -75,6 +83,14 @@ to use `yarn link`. You can read more about it at [yarn-link: Symlink a package
|
|||||||
|
|
||||||
**Quick start**:
|
**Quick start**:
|
||||||
|
|
||||||
|
- Node.js >= 10.14.2:
|
||||||
|
```shell
|
||||||
|
~/windshaft-directory $ npm ci
|
||||||
|
~/windshaft-directory $ npm link
|
||||||
|
~/windshaft-cartodb-directory $ npm link windshaft
|
||||||
|
```
|
||||||
|
|
||||||
|
- Node.js 6.9.2:
|
||||||
```shell
|
```shell
|
||||||
~/windshaft-directory $ yarn
|
~/windshaft-directory $ yarn
|
||||||
~/windshaft-directory $ yarn link
|
~/windshaft-directory $ yarn link
|
||||||
|
@ -70,7 +70,8 @@
|
|||||||
"docker-bash": "./docker-bash.sh"
|
"docker-bash": "./docker-bash.sh"
|
||||||
},
|
},
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=6.9",
|
"node": "6.9.2 || >= 10.14.2",
|
||||||
"yarn": ">=0.27.5 <1.0.0"
|
"npm": "3.10.9 || 3.10.10 || >= 6.4.1",
|
||||||
}
|
"yarn": "0.27.5"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
Loading…
Reference in New Issue
Block a user