The Kinvey JavaScript SDK core is a package that can be used to develop JavaScript applications on the Kinvey platform. The Kinvey JavaScript SDK core is intended used as a way to share common code across different Kinvey JavaScript SDK builds.
The simplest way to build the sdk is by running gulp
. More advanced tasks are available.
gulp bump
: bump the pacakge versiongulp build
: build the sdkgulp clean
: remove files created by the build processgulp release
: release a new version of the sdk
The following flags are available when running gulp bump
:
--type <major|minor|patch|prerelease>
: Bumps the package version using the Semantic Version 2.0.0 spec. Defaults topatch
.--version <version>
: Sets the package version to the provided version.
You can run the tests using npm test
.
The workflow for releasing a new version of the sdk is as follows:
- Commit all changes on the develop branch.
- Checkout the master branch and merge the develop branch.
- Update the Changelog.
- Run
gulp bump --type <type>
replacing<type>
with major, minor, patch, or prerelease. See Flags above. - Make sure all changes are committed on the master branch and push.
Updating the sdk version should follow Semantic Version 2.0.0:
- Major (x.0.0): when making incompatible API changes.
- Minor (3.x.0): when adding functionality in a backwards-compatible manner.
- Patch (3.0.x): when making backwards-compatible bug fixes or enhancements.
Copyright 2016 Kinvey, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.