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–it includes more than just a few 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-PATCH. Apify SDK is currently on version 1.1.0.

This means:

  1. MAJOR  version is changed when you make incompatible API changes - also called breaking changes.

  2. MINOR  version gets updated when you add functionality in a backward-compatible manner.

  3. PATCH is updated when you modify existing functionality in a backward-compatible manner.

So you can safely update from version 1.0.0  to 1.1.0  as it's a MINOR  update that should not introduce any breaking changes. However, if you plan to update from version 0.22.4  to 1.1.0, you need to read version 1.1.0's changelog to find out if you are affected by some of the API changes introduced there.

Apify SDK's changelog is on Github:

https://github.com/apifytech/apify-js/releases

How to update

Apify app - single file editor

If you are developing an actor in the Apify app using a single file editor, simply press the Clean build button to rebuild your actor. Clean build always uses the latest images containing the latest version of Apify SDK.

Apify app - multi-file editor

If you are developing an actor in the Apify app using the multi-file editor, one of the files is package.json, which contains 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": "^1.0.0"
},

Read more about package.json file in the NPM documentation. After you update Apify SDK version in the 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 the NPM documentation.

Did this answer your question?