apify-cli 0.20.3 → 0.20.4-beta.0

package/CHANGELOG.md

@@ -1,7 +1,7 @@
 **Changelog file is no longer maintained, you can check all changes in [GitHub Releases](https://github.com/apify/apify-cli/releases).**
 
-0.6.1 / 2020-05-18
-==================
+# 0.6.1 / 2020-05-18
+
 - **BREAKING:** Templates are now fully decoupled from this project and
   the [templates repository](https://github.com/apify/actor-templates)
   serves as the single source of truth. Some templates were replaced
@@ -11,190 +11,184 @@
   This is to support regular changes to templates without breaking older
   versions of the CLI.
 
-0.5.3 / 2020-03-03
-==================
+  # 0.5.3 / 2020-03-03
+
 - Moved templates to separate repository
 - Fixed: creating `apify_storage` in root folder after `apify create` command
 
-0.5.2 / 2020-01-22
-==================
+  # 0.5.2 / 2020-01-22
+
 - Added bot(dependabot.com) to check latest Apify SDK version in all templates
 - Updated apify package in all templates
 - Updated npm packages and fixed all npm audit issues
 
-0.5.1 / 2019-12-19
-==================
+  # 0.5.1 / 2019-12-19
+
 - Added warning about outdated node.js version
 - Fixed infinite push, when the previous one was interrupted
 - Fixed calling public actors with `apify call`
 - `apify init` create empty INPUT.json file
 
-0.5.0 / 2019-11-27
-==================
+  # 0.5.0 / 2019-11-27
+
 - Drop support for node 8 and 9
 - Fix: Pass the --max-http-header-size=80000 to the nodeJs process
 
-0.4.1 / 2019-10-02
-==================
+  # 0.4.1 / 2019-10-02
+
 - New actor template for Apify projects, you can create it with `apify create --template apify_project`
 - `apify vis` - Using improved schema validator
 
-0.4.0 / 2019-09-23
-==================
+  # 0.4.0 / 2019-09-23
+
 - Breaking Change - `apify push`: Pushes source code as a "Multiple source files" in case source code is less that 3 MB
 
-0.3.12 / 2019-09-18
-==================
-Bug fixes:
+  # 0.3.12 / 2019-09-18
+
+  Bug fixes:
+
 - `apify create`: Added validation for actor name
 - `apify init` skips creation of apify.json if already exists
 - `apify run -p` runs actor, if apify_storage doesn't exist
 - Updated packages
 - Additional minor fixes
 
-0.3.11 / 2019-07-26
-==================
+  # 0.3.11 / 2019-07-26
+
 - Updated packages
 - Updated Cheerio Crawler template
 - Updated Apify package version in all templates
 
-0.3.10 / 2019-06-03
-==================
+  # 0.3.10 / 2019-06-03
+
 - Updated packages
 
-0.3.9 / 2019-05-15
-==================
+  # 0.3.9 / 2019-05-15
+
 - Improved the templates and texts
 
-0.3.8 / 2019-03-29
-==================
+  # 0.3.8 / 2019-03-29
+
 - Updated all templates regarding the last version of apify SDK.
 
-0.3.7 / 2019-03-18
-==================
+  # 0.3.7 / 2019-03-18
+
 - Fixed templates to use Apify.getInput(), replaced deprecated function and options,
-added debug fields, added .idea to .gitignore
+  added debug fields, added .idea to .gitignore
 - Updated packages
 - Fixed bug: Users without username can use push/call command
 
-0.3.6 / 2019-01-29
-==================
+  # 0.3.6 / 2019-01-29
+
 - Added command `apify vis` that validates actor input schema.
 
-0.3.5 / 2019-01-25
-==================
+  # 0.3.5 / 2019-01-25
+
 - Upgraded to apify@0.11 in templates
 
-0.3.3 / 2018-12-12
-==================
+  # 0.3.3 / 2018-12-12
+
 - Omitted CMD command in all templates Dockerfile.
 
-0.3.2 / 2018-12-05
-==================
+  # 0.3.2 / 2018-12-05
+
 - Updated apify-client package. It fixed bug, when user can not push actor, whe he changed version in apify.json.
 
-0.3.1 / 2018-11-29
-==================
+  # 0.3.1 / 2018-11-29
+
 - :tada: New commands to manage secret environment variables: `apify secrets:add`, `apify secrets:rm`.
 - New documentation how to set environment variable in `apify.json`, see [documentation](https://github.com/apify/apify-cli/blob/master/README.md#environment-variables).
 - **BREAKING CHANGES**: Simplified `apify.json` structure. It will be updated automatically before execution apify run and push command.
 - Command `apify create` now shows progress bar of npm install.
 - Small bugs fixes
 
-0.2.7 / 2018-11-27
-==================
+  # 0.2.7 / 2018-11-27
+
 - Updated all templates to latest apify packages
 
-0.2.6 / 2018-11-09
-==================
+  # 0.2.6 / 2018-11-09
+
 - Added warning if `apify run` reuse old state in storage
 - Fixed issues #70 #65 #68
 
-0.2.5 / 2018-10-31
-==================
+  # 0.2.5 / 2018-10-31
+
 - Updated NPM dependencies
 - Upgraded to apify-shared@0.1.6
 - Fixed templates to use apify/actor-node-chrome Docker image instead of outdated apify/actor-node-puppeteer
 
-0.2.3 / 2018-09-17
-==================
-- Updated all templates to apify version 0.8.*
+  # 0.2.3 / 2018-09-17
+
+- Updated all templates to apify version 0.8.\*
 - Added template named hello_word
 
-0.2.1 / 2018-09-17
-==================
+  # 0.2.1 / 2018-09-17
+
 - **BREAKING CHANGES**: The local storage directories have been renamed and package.json files needs a new `start` command.
-  See [migration guide](/MIGRATIONS.md) for existing projects if you are upgrading from 0.1.* to 0.2.*.
+  See [migration guide](/MIGRATIONS.md) for existing projects if you are upgrading from 0.1._ to 0.2._.
 - You can specified another file that main.js for `apify run` command using npm start script.
 
-0.2.0 / 2018-09-12
-==================
+  # 0.2.0 / 2018-09-12
+
 - **BREAKING CHANGES**: Version 0.2.0 of Apify CLI supports only version 0.7.0 of API SDK or newer as management of environment variables
   has been changed according to Apify SDK version 0.7.0.
 - Dropped support for Node 7
 
-0.1.18 / 2018-09-12
-===================
+  # 0.1.18 / 2018-09-12
+
 - Updated NPM dependencies, npm-shrinkwrap.json replaced with package-lock.json
 - Updated NPM dependencies in code templates
 
-0.1.15 / 2018-07-23
-===================
+  # 0.1.15 / 2018-07-23
+
 - Rename act to actor
 
-0.1.13 / 2018-07-12
-===================
+  # 0.1.13 / 2018-07-12
+
 - Add environment variables for enable live view for local actors.
 
-0.1.12 / 2018-06-28
-===================
+  # 0.1.12 / 2018-06-28
+
 - From now `apify call` and `apify push` commands stream live logs from run and build to your terminal
 - Add options -p, --purge, --purge-dataset, --purge-key-value-store, --purge-queue in `apify run` to clean stores before runs actor locally
 - Add option -w, --wait-for-finish=wait-for-finish in `apify push` and `apify call` - command waits x seconds to finish run or build on Apify
 - Fixes #26, #33, #34, #36, #38, #39, #37, #35
 
-0.1.11 / 2018-05-30
-===================
+  # 0.1.11 / 2018-05-30
+
 - Use npm-shrinkwrap.json instead of package-lock.json for published module
 - Update template, where we using proxy
 - Fix #30
 
-0.1.9 / 2018-04-18
-==================
+  # 0.1.9 / 2018-04-18
+
 - apify run takes APIFY_USER_ID and APIFY_TOKEN as environments variables, if client is logged locally
 - apify call takes input from default local key-value-store
 - Fix: duplicates new lines in log
 
-0.1.8 / 2018-04-17
-==================
+  # 0.1.8 / 2018-04-17
+
 - Print warning if you have old version of cli
 - apify run - kills all sub processes for SIGINT signal (ctrl+c) - It kills all related browsers in apify run command, related issue:
   https://github.com/apify/apify-js/issues/72
 
-0.1.7 / 2018-04-12
-==================
+  # 0.1.7 / 2018-04-12
+
 - Readme and templates updates
 
-0.1.6 / 2018-04-11
-==================
+  # 0.1.6 / 2018-04-11
+
 - Add support for request queue
 
-0.1.5 / 2018-04-09
-==================
+  # 0.1.5 / 2018-04-09
+
 - Works for windows
 - New command apify info
 
-0.1.x / 2018-04-01
-==================
-- The first public release
-
-0.0.x / 2018-03-01
-==================
-- Initial development, lot of new stuff
-
-
-
-
+  # 0.1.x / 2018-04-01
 
+- The first public release
 
+  # 0.0.x / 2018-03-01
 
+- Initial development, lot of new stuff

package/README.md

@@ -19,7 +19,6 @@ Note that Actors running on the Apify platform are executed in Docker containers
 you can build your Actors in any programming language.
 However, we recommend using JavaScript / Node.js, for which we provide most libraries and support.
 
-
 ## Installation
 
 ### Via Homebrew
@@ -66,6 +65,7 @@ apify --version
 ```
 
 which should print something like:
+
 ```
 apify-cli/0.10.0 darwin-x64 node-v16.14.2
 ```
@@ -94,10 +94,12 @@ for the Actor and a few configuration files.
 cd ./my/awesome/project
 apify init
 ```
+
 This command will only set up local Actor development environment in an existing directory,
 i.e. it will create the `.actor/actor.json` file and `apify_storage` directory.
 
 Before you can run your project locally using `apify run`, you have to set up the right start command in `package.json` under scripts.start. For example:
+
 ```text
 {
     ...
@@ -107,6 +109,7 @@ Before you can run your project locally using `apify run`, you have to set up th
     ...
 }
 ```
+
 You can find more information about by running `apify help run`.
 
 ### Create a new Actor from Scrapy project
@@ -134,7 +137,6 @@ and log in to it using the above command. You will be prompted for
 your [Apify API token](https://console.apify.com/settings/integrations).
 Note that the command will store the API token and other sensitive information to `~/.apify`.
 
-
 ### Push the Actor to the Apify cloud
 
 ```bash
@@ -165,7 +167,6 @@ Make sure you commit this file to the Git repository.
 
 For example, `.actor/actor.json` file can look as follows:
 
-
 ```json
 {
   "actorSpecification": 1,
@@ -173,8 +174,8 @@ For example, `.actor/actor.json` file can look as follows:
   "version": "0.0",
   "buildTag": "latest",
   "environmentVariables": {
-      "MYSQL_USER": "my_username",
-      "MYSQL_PASSWORD": "@mySecretPassword"
+    "MYSQL_USER": "my_username",
+    "MYSQL_PASSWORD": "@mySecretPassword"
   },
   "dockerfile": "./Dockerfile",
   "readme": "./ACTOR.md",
@@ -198,48 +199,54 @@ You can embed your [input schema](https://docs.apify.com/actors/development/inpu
 You can define the schema of the items in your dataset under the `storages.dataset` field. This can be either an embedded object or a path to a JSON schema file. You can read more about the schema of your Actor output [here](https://docs.apify.com/actors/development/output-schema#specification-version-1).
 
 **Note on migration from deprecated config "apify.json"**\
-*Note that previously, Actor config was stored in the `apify.json` file that has been deprecated. You can find the (very slight) differences and migration info in [migration guidelines](https://github.com/apify/apify-cli/blob/master/MIGRATIONS.md).*
+_Note that previously, Actor config was stored in the `apify.json` file that has been deprecated. You can find the (very slight) differences and migration info in [migration guidelines](https://github.com/apify/apify-cli/blob/master/MIGRATIONS.md)._
 
 ## Environment variables
 
 There are two options how you can set up environment variables for Actors.
 
 ### Set up environment variables in .actor/actor.json
+
 All keys from `env` will be set as environment variables into Apify platform after you push Actor to Apify. Current values on Apify will be overridden.
+
 ```json
 {
-    "actorSpecification": 1,
-    "name": "dataset-to-mysql",
-    "version": "0.1",
-    "buildTag": "latest",
-    "environmentVariables": {
-      "MYSQL_USER": "my_username",
-      "MYSQL_PASSWORD": "@mySecretPassword"
-    }
+  "actorSpecification": 1,
+  "name": "dataset-to-mysql",
+  "version": "0.1",
+  "buildTag": "latest",
+  "environmentVariables": {
+    "MYSQL_USER": "my_username",
+    "MYSQL_PASSWORD": "@mySecretPassword"
+  }
 }
 ```
 
 ### Set up environment variables in Apify Console
+
 In [Apify Console](https://console.apify.com/actors) select your Actor, you can set up variables into Source tab.
 After setting up variables in the app, remove the `environmentVariables` from `.actor/actor.json`. Otherwise, variables from `.actor/actor.json` will override variables in the app.
+
 ```json
 {
-    "actorSpecification": 1,
-    "name": "dataset-to-mysql",
-    "version": "0.1",
-    "buildTag": "latest"
+  "actorSpecification": 1,
+  "name": "dataset-to-mysql",
+  "version": "0.1",
+  "buildTag": "latest"
 }
 ```
 
-
 #### How to set secret environment variables in .actor/actor.json
 
 CLI provides commands to manage secrets environment variables. Secrets are stored to the `~/.apify` directory.
 You can add a new secret using the command:
+
 ```bash
 apify secrets:add mySecretPassword pwd1234
 ```
+
 After adding a new secret you can use the secret in `.actor/actor.json`.
+
 ```text
 {
     "actorSpecification": 1,
@@ -269,11 +276,11 @@ apify help COMMAND
 Still haven't found what you were looking for? Please go to [Apify Help center](https://www.apify.com/help)
 or [contact us](https://www.apify.com/contact).
 
-
 ## Command reference
 
 This section contains printouts of `apify help` for all commands.
 
+<!-- prettier-ignore-start -->
 <!-- commands -->
 * [`apify actor`](#apify-actor)
 * [`apify actor get-input`](#apify-actor-get-input)
@@ -309,7 +316,7 @@ DESCRIPTION
   Commands are designed to be used in Actor runs. All commands are in PoC state, do not use in production environments.
 ```
 
-_See code: [src/commands/actor/index.ts](https://github.com/apify/apify-cli/blob/v0.20.3/src/commands/actor/index.ts)_
+_See code: [src/commands/actor/index.ts](https://github.com/apify/apify-cli/blob/v0.20.4-beta.0/src/commands/actor/index.ts)_
 
 ## `apify actor get-input`
 
@@ -323,7 +330,7 @@ DESCRIPTION
   Gets the Actor input value from the default key-value store associated with the Actor run.
 ```
 
-_See code: [src/commands/actor/get-input.ts](https://github.com/apify/apify-cli/blob/v0.20.3/src/commands/actor/get-input.ts)_
+_See code: [src/commands/actor/get-input.ts](https://github.com/apify/apify-cli/blob/v0.20.4-beta.0/src/commands/actor/get-input.ts)_
 
 ## `apify actor get-value KEY`
 
@@ -340,7 +347,7 @@ DESCRIPTION
   Gets a value from the default key-value store associated with the Actor run.
 ```
 
-_See code: [src/commands/actor/get-value.ts](https://github.com/apify/apify-cli/blob/v0.20.3/src/commands/actor/get-value.ts)_
+_See code: [src/commands/actor/get-value.ts](https://github.com/apify/apify-cli/blob/v0.20.4-beta.0/src/commands/actor/get-value.ts)_
 
 ## `apify actor push-data [ITEM]`
 
@@ -362,7 +369,7 @@ DESCRIPTION
   $ cat ./test.json | apify actor push-data
 ```
 
-_See code: [src/commands/actor/push-data.ts](https://github.com/apify/apify-cli/blob/v0.20.3/src/commands/actor/push-data.ts)_
+_See code: [src/commands/actor/push-data.ts](https://github.com/apify/apify-cli/blob/v0.20.4-beta.0/src/commands/actor/push-data.ts)_
 
 ## `apify actor set-value KEY [VALUE]`
 
@@ -391,7 +398,7 @@ DESCRIPTION
   $ cat ./my-text-file.txt | apify actor set-value KEY --contentType text/plain
 ```
 
-_See code: [src/commands/actor/set-value.ts](https://github.com/apify/apify-cli/blob/v0.20.3/src/commands/actor/set-value.ts)_
+_See code: [src/commands/actor/set-value.ts](https://github.com/apify/apify-cli/blob/v0.20.4-beta.0/src/commands/actor/set-value.ts)_
 
 ## `apify call [ACTORID]`
 
@@ -421,7 +428,7 @@ DESCRIPTION
   takes input for the Actor from the default local key-value store by default.
 ```
 
-_See code: [src/commands/call.ts](https://github.com/apify/apify-cli/blob/v0.20.3/src/commands/call.ts)_
+_See code: [src/commands/call.ts](https://github.com/apify/apify-cli/blob/v0.20.4-beta.0/src/commands/call.ts)_
 
 ## `apify create [ACTORNAME]`
 
@@ -446,7 +453,7 @@ DESCRIPTION
   Creates a new Actor project directory from a selected boilerplate template.
 ```
 
-_See code: [src/commands/create.ts](https://github.com/apify/apify-cli/blob/v0.20.3/src/commands/create.ts)_
+_See code: [src/commands/create.ts](https://github.com/apify/apify-cli/blob/v0.20.4-beta.0/src/commands/create.ts)_
 
 ## `apify help [COMMAND]`
 
@@ -481,7 +488,7 @@ DESCRIPTION
   The information is printed to the console.
 ```
 
-_See code: [src/commands/info.ts](https://github.com/apify/apify-cli/blob/v0.20.3/src/commands/info.ts)_
+_See code: [src/commands/info.ts](https://github.com/apify/apify-cli/blob/v0.20.4-beta.0/src/commands/info.ts)_
 
 ## `apify init [ACTORNAME]`
 
@@ -509,7 +516,7 @@ DESCRIPTION
   WARNING: The directory at "storage" will be overwritten if it already exists.
 ```
 
-_See code: [src/commands/init.ts](https://github.com/apify/apify-cli/blob/v0.20.3/src/commands/init.ts)_
+_See code: [src/commands/init.ts](https://github.com/apify/apify-cli/blob/v0.20.4-beta.0/src/commands/init.ts)_
 
 ## `apify login`
 
@@ -530,7 +537,7 @@ DESCRIPTION
   "apify" commands. To log out, call "apify logout".
 ```
 
-_See code: [src/commands/login.ts](https://github.com/apify/apify-cli/blob/v0.20.3/src/commands/login.ts)_
+_See code: [src/commands/login.ts](https://github.com/apify/apify-cli/blob/v0.20.4-beta.0/src/commands/login.ts)_
 
 ## `apify logout`
 
@@ -546,7 +553,7 @@ DESCRIPTION
   call "apify login".
 ```
 
-_See code: [src/commands/logout.ts](https://github.com/apify/apify-cli/blob/v0.20.3/src/commands/logout.ts)_
+_See code: [src/commands/logout.ts](https://github.com/apify/apify-cli/blob/v0.20.4-beta.0/src/commands/logout.ts)_
 
 ## `apify pull [ACTORID]`
 
@@ -568,7 +575,7 @@ DESCRIPTION
   cloned. If it is defined as Web IDE, it will fetch the files.
 ```
 
-_See code: [src/commands/pull.ts](https://github.com/apify/apify-cli/blob/v0.20.3/src/commands/pull.ts)_
+_See code: [src/commands/pull.ts](https://github.com/apify/apify-cli/blob/v0.20.4-beta.0/src/commands/pull.ts)_
 
 ## `apify push [ACTORID]`
 
@@ -606,7 +613,7 @@ DESCRIPTION
   overwritten with --force flag.
 ```
 
-_See code: [src/commands/push.ts](https://github.com/apify/apify-cli/blob/v0.20.3/src/commands/push.ts)_
+_See code: [src/commands/push.ts](https://github.com/apify/apify-cli/blob/v0.20.4-beta.0/src/commands/push.ts)_
 
 ## `apify run`
 
@@ -642,7 +649,7 @@ DESCRIPTION
   package.json file. You can set up your own main file or environment variables by changing it.
 ```
 
-_See code: [src/commands/run.ts](https://github.com/apify/apify-cli/blob/v0.20.3/src/commands/run.ts)_
+_See code: [src/commands/run.ts](https://github.com/apify/apify-cli/blob/v0.20.4-beta.0/src/commands/run.ts)_
 
 ## `apify secrets`
 
@@ -672,7 +679,7 @@ DESCRIPTION
   of the Actor.
 ```
 
-_See code: [src/commands/secrets/index.ts](https://github.com/apify/apify-cli/blob/v0.20.3/src/commands/secrets/index.ts)_
+_See code: [src/commands/secrets/index.ts](https://github.com/apify/apify-cli/blob/v0.20.4-beta.0/src/commands/secrets/index.ts)_
 
 ## `apify secrets add NAME VALUE`
 
@@ -691,7 +698,7 @@ DESCRIPTION
   The secrets are stored to a file at ~/.apify
 ```
 
-_See code: [src/commands/secrets/add.ts](https://github.com/apify/apify-cli/blob/v0.20.3/src/commands/secrets/add.ts)_
+_See code: [src/commands/secrets/add.ts](https://github.com/apify/apify-cli/blob/v0.20.4-beta.0/src/commands/secrets/add.ts)_
 
 ## `apify secrets rm NAME`
 
@@ -708,7 +715,7 @@ DESCRIPTION
   Removes the secret.
 ```
 
-_See code: [src/commands/secrets/rm.ts](https://github.com/apify/apify-cli/blob/v0.20.3/src/commands/secrets/rm.ts)_
+_See code: [src/commands/secrets/rm.ts](https://github.com/apify/apify-cli/blob/v0.20.4-beta.0/src/commands/secrets/rm.ts)_
 
 ## `apify task`
 
@@ -722,7 +729,7 @@ DESCRIPTION
   Commands are designed to be used to interact with Tasks.
 ```
 
-_See code: [src/commands/task/index.ts](https://github.com/apify/apify-cli/blob/v0.20.3/src/commands/task/index.ts)_
+_See code: [src/commands/task/index.ts](https://github.com/apify/apify-cli/blob/v0.20.4-beta.0/src/commands/task/index.ts)_
 
 ## `apify task run TASKID`
 
@@ -747,7 +754,7 @@ DESCRIPTION
   takes input for the Actor from the default local key-value store by default.
 ```
 
-_See code: [src/commands/task/run.ts](https://github.com/apify/apify-cli/blob/v0.20.3/src/commands/task/run.ts)_
+_See code: [src/commands/task/run.ts](https://github.com/apify/apify-cli/blob/v0.20.4-beta.0/src/commands/task/run.ts)_
 
 ## `apify validate-schema [PATH]`
 
@@ -772,5 +779,6 @@ DESCRIPTION
   You can also pass any custom path to your input schema to have it validated instead.
 ```
 
-_See code: [src/commands/validate-schema.ts](https://github.com/apify/apify-cli/blob/v0.20.3/src/commands/validate-schema.ts)_
+_See code: [src/commands/validate-schema.ts](https://github.com/apify/apify-cli/blob/v0.20.4-beta.0/src/commands/validate-schema.ts)_
 <!-- commandsstop -->
+<!-- prettier-ignore-end -->