Prepare scoped Node package (#6386)
In case we're not able to get access to the unscoped credentials. Scoped packages are also the recommended approach for projects managed by a team of developers.
This commit is contained in:
parent
7be9039f53
commit
ac1edc7675
@ -58,6 +58,7 @@
|
|||||||
- CHANGED: Docker build, enabled arm64 build layer [#6172](https://github.com/Project-OSRM/osrm-backend/pull/6172)
|
- CHANGED: Docker build, enabled arm64 build layer [#6172](https://github.com/Project-OSRM/osrm-backend/pull/6172)
|
||||||
- CHANGED: Docker build, enabled apt-get update/install caching in separate layer for build phase [#6175](https://github.com/Project-OSRM/osrm-backend/pull/6175)
|
- CHANGED: Docker build, enabled apt-get update/install caching in separate layer for build phase [#6175](https://github.com/Project-OSRM/osrm-backend/pull/6175)
|
||||||
- FIXED: Bump CI complete meta job to ubuntu-20.04 [#6323](https://github.com/Project-OSRM/osrm-backend/pull/6323)
|
- FIXED: Bump CI complete meta job to ubuntu-20.04 [#6323](https://github.com/Project-OSRM/osrm-backend/pull/6323)
|
||||||
|
- CHANGED: Node packages are now scoped by @project-osrm [#6386](https://github.com/Project-OSRM/osrm-backend/issues/6386)
|
||||||
- Routing:
|
- Routing:
|
||||||
- CHANGED: Lazily generate optional route path data [#6045](https://github.com/Project-OSRM/osrm-backend/pull/6045)
|
- CHANGED: Lazily generate optional route path data [#6045](https://github.com/Project-OSRM/osrm-backend/pull/6045)
|
||||||
- FIXED: Completed support for no_entry and no_exit turn restrictions. [#5988](https://github.com/Project-OSRM/osrm-backend/pull/5988)
|
- FIXED: Completed support for no_entry and no_exit turn restrictions. [#5988](https://github.com/Project-OSRM/osrm-backend/pull/5988)
|
||||||
|
13
README.md
13
README.md
@ -141,7 +141,7 @@ sudo apt-get update -y
|
|||||||
sudo apt-get install -y libstdc++-9-dev
|
sudo apt-get install -y libstdc++-9-dev
|
||||||
```
|
```
|
||||||
|
|
||||||
You can install the Node.js bindings via `npm install osrm` or from this repository either via
|
You can install the Node.js bindings via `npm install @project-osrm/osrm` or from this repository either via
|
||||||
|
|
||||||
npm install
|
npm install
|
||||||
|
|
||||||
@ -151,6 +151,17 @@ which will check and use pre-built binaries if they're available for this releas
|
|||||||
|
|
||||||
to always force building the Node.js bindings from source.
|
to always force building the Node.js bindings from source.
|
||||||
|
|
||||||
|
#### Unscoped packages
|
||||||
|
|
||||||
|
Prior to v5.27.0, the `osrm` Node package was unscoped. If you are upgrading from an old package, you will need to do the following:
|
||||||
|
|
||||||
|
```
|
||||||
|
npm uninstall osrm --save
|
||||||
|
npm install @project-osrm/osrm --save
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Package docs
|
||||||
|
|
||||||
For usage details have a look [these API docs](docs/nodejs/api.md).
|
For usage details have a look [these API docs](docs/nodejs/api.md).
|
||||||
|
|
||||||
An exemplary implementation by a 3rd party with Docker and Node.js can be found [here](https://github.com/door2door-io/osrm-express-server-demo).
|
An exemplary implementation by a 3rd party with Docker and Node.js can be found [here](https://github.com/door2door-io/osrm-express-server-demo).
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
{
|
{
|
||||||
"name": "osrm",
|
"name": "@project-osrm/osrm",
|
||||||
"version": "5.27.0-unreleased",
|
"version": "5.27.0-unreleased",
|
||||||
"private": false,
|
"private": false,
|
||||||
"description": "The Open Source Routing Machine is a high performance routing engine written in C++14 designed to run on OpenStreetMap data.",
|
"description": "The Open Source Routing Machine is a high performance routing engine written in C++14 designed to run on OpenStreetMap data.",
|
||||||
@ -81,5 +81,8 @@
|
|||||||
"host": "https://github.com",
|
"host": "https://github.com",
|
||||||
"remote_path": "./Project-OSRM/osrm-backend/releases/download/v{version}/",
|
"remote_path": "./Project-OSRM/osrm-backend/releases/download/v{version}/",
|
||||||
"package_name": "{module_name}-v{version}-{node_abi}-{platform}-{arch}-{configuration}.tar.gz"
|
"package_name": "{module_name}-v{version}-{node_abi}-{platform}-{arch}-{configuration}.tar.gz"
|
||||||
|
},
|
||||||
|
"publishConfig": {
|
||||||
|
"access": "public"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
Loading…
Reference in New Issue
Block a user