A new version of Apify SDK is released every couple of days. You don't need to update to the newer version, but we recommend you do so, as it doesn't only include new features, but usually also contains bug fixes for common problems.

Apify follows semantic versioning specification for all public projects and the version, e.g. 1.5.4 is composed of three numbers: MAJOR-MINOR-PATH.  As version 1.0.0  of Apify SDK is not released yet, the versioning starts with a 0  and the version has the structure 0-MAJOR-MINOR. At the time of writing, the current version was 0.15.2 where 15  is MAJOR  version and 2  is a MINOR  version.

What this means is:

  1. MAJOR  version gets changed when you make incompatible API changes - also called breaking changes.
  2. MINOR  version gets updated when you add functionality in a backwards-compatible manner or patch existing functionality in backwards-compatible manner.

So you can safely update from version 0.13.3  to 0.13.4  as it's a MINOR  update that should not introduce any breaking changes. But if you plan to update from 0.13.4  to 0.14.1  then you need to read the changelog of version 0.14.0 to find out if you are affected by some of the API changes introduced there.

The changelog for Apify SDK is located at its Github repository:
https://github.com/apifytech/apify-js/releases

How to update

Apify platform - single file editor

If you are developing on the Apify platform using a single file editor then simply press a "clean build" button to rebuild your actor. Clean build always uses the latest images containing the latest version of Apify SDK.

Apify platform - multifile editor

If you are developing on the Apify platform using a multiple editor then one of the files is a package.json  file containing all the NPM dependencies needed for your project including Apify SDK. You can update the version of Apify SDK in the following section:

"dependencies": {
    "apify": "^0.15.2"
},

Read more about package.json file in NPM documentation. After you update Apify SDK version in a package.json file, you must rebuild the actor so that the changes take effect.

Locally

If you are developing your actor locally then you can install the latest version of Apify SDK via the following NPM command:

npm install apify@latest

Read more about npm install  in NPM documentation.

Did this answer your question?