Skip to content

Commit

Permalink
feat: updated input schema package (#293)
Browse files Browse the repository at this point in the history
Updated input schema package since it now has two new editor options and
improved validation.

Co-authored-by: Jaroslav Hejlek <[email protected]>
  • Loading branch information
gippy and Jaroslav Hejlek authored Nov 10, 2022
1 parent a007a4a commit fe472f2
Show file tree
Hide file tree
Showing 5 changed files with 44 additions and 42 deletions.
12 changes: 7 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,17 @@ Only users with access to [apify-cli package](https://www.npmjs.com/package/apif

Release of new versions is managed by GitHub Actions. On pushes to the master branch, prerelease versions are automatically produced. Latest releases are triggered manually through the GitHub release tool. After creating a release there, Actions will automatically produce the latest version of the package.

1. Before publishing new version you have to generate and commit production `npm-shrinkwrap.json`
`npm run prod-shrinkwrap`
NOTE: File `package-lock.json` will be completely ignored during package publishing. Using `npm-shrinkwrap.json` will correctly lock dependencies.
1. Manually increment version in `package.json`

2. Create manifest file `npm run manifest`

3. Generate command reference to `README.md`:
`npm run commands-md`

4. GitHub Actions build is triggered by a push to `master` (typically a merge of a PR). If it breaks with a `version already exists error` increment version in `package.json` and push again.
4. Before publishing new version you have to generate and commit production `npm-shrinkwrap.json`
`npm run prod-shrinkwrap`
NOTE: File `package-lock.json` will be completely ignored during package publishing. Using `npm-shrinkwrap.json` will correctly lock dependencies.

5. GitHub Actions build is triggered by a push to `master` (typically a merge of a PR).

5. To trigger the latest release, go to the GitHub release tool (select `releases` under `<> Code`). There, draft a new release, fill the form and hit `Publish release`. Actions will automatically release the latest version of the package.
6. To trigger the latest release, go to the GitHub release tool (select `releases` under `<> Code`). There, draft a new release, fill the form and hit `Publish release`. Actions will automatically release the latest version of the package.
34 changes: 17 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,7 @@ USAGE
$ apify actor
```

_See code: [src/commands/actor/index.js](https://github.com/apify/apify-cli/blob/v0.9.0/src/commands/actor/index.js)_
_See code: [src/commands/actor/index.js](https://github.com/apify/apify-cli/blob/v0.10.0/src/commands/actor/index.js)_

## `apify actor:get-input`

Expand All @@ -273,7 +273,7 @@ USAGE
$ apify actor:get-input
```

_See code: [src/commands/actor/get-input.js](https://github.com/apify/apify-cli/blob/v0.9.0/src/commands/actor/get-input.js)_
_See code: [src/commands/actor/get-input.js](https://github.com/apify/apify-cli/blob/v0.10.0/src/commands/actor/get-input.js)_

## `apify actor:get-value KEY`

Expand All @@ -287,7 +287,7 @@ ARGUMENTS
KEY Key of the record in key-value store
```

_See code: [src/commands/actor/get-value.js](https://github.com/apify/apify-cli/blob/v0.9.0/src/commands/actor/get-value.js)_
_See code: [src/commands/actor/get-value.js](https://github.com/apify/apify-cli/blob/v0.10.0/src/commands/actor/get-value.js)_

## `apify actor:push-data [ITEM]`

Expand All @@ -308,7 +308,7 @@ DESCRIPTION
$ cat ./test.json | apify actor:push-data
```

_See code: [src/commands/actor/push-data.js](https://github.com/apify/apify-cli/blob/v0.9.0/src/commands/actor/push-data.js)_
_See code: [src/commands/actor/push-data.js](https://github.com/apify/apify-cli/blob/v0.10.0/src/commands/actor/push-data.js)_

## `apify actor:set-value KEY [VALUE]`

Expand Down Expand Up @@ -338,7 +338,7 @@ DESCRIPTION
$ cat ./my-text-file.txt | apify actor:set-value KEY --contentType text/plain
```

_See code: [src/commands/actor/set-value.js](https://github.com/apify/apify-cli/blob/v0.9.0/src/commands/actor/set-value.js)_
_See code: [src/commands/actor/set-value.js](https://github.com/apify/apify-cli/blob/v0.10.0/src/commands/actor/set-value.js)_

## `apify call [ACTID]`

Expand All @@ -363,7 +363,7 @@ DESCRIPTION
takes input for the actor from the default local key-value store by default.
```

_See code: [src/commands/call.js](https://github.com/apify/apify-cli/blob/v0.9.0/src/commands/call.js)_
_See code: [src/commands/call.js](https://github.com/apify/apify-cli/blob/v0.10.0/src/commands/call.js)_

## `apify create [ACTORNAME]`

Expand All @@ -382,7 +382,7 @@ OPTIONS
find available template names.
```

_See code: [src/commands/create.js](https://github.com/apify/apify-cli/blob/v0.9.0/src/commands/create.js)_
_See code: [src/commands/create.js](https://github.com/apify/apify-cli/blob/v0.10.0/src/commands/create.js)_

## `apify info`

Expand All @@ -396,7 +396,7 @@ DESCRIPTION
The information is printed to the console.
```

_See code: [src/commands/info.js](https://github.com/apify/apify-cli/blob/v0.9.0/src/commands/info.js)_
_See code: [src/commands/info.js](https://github.com/apify/apify-cli/blob/v0.10.0/src/commands/info.js)_

## `apify init [ACTORNAME]`

Expand All @@ -416,7 +416,7 @@ DESCRIPTION
WARNING: The directory at "storage" will be overwritten if it already exists.
```

_See code: [src/commands/init.js](https://github.com/apify/apify-cli/blob/v0.9.0/src/commands/init.js)_
_See code: [src/commands/init.js](https://github.com/apify/apify-cli/blob/v0.10.0/src/commands/init.js)_

## `apify login`

Expand All @@ -434,7 +434,7 @@ DESCRIPTION
"apify" commands. To log out, call "apify logout".
```

_See code: [src/commands/login.js](https://github.com/apify/apify-cli/blob/v0.9.0/src/commands/login.js)_
_See code: [src/commands/login.js](https://github.com/apify/apify-cli/blob/v0.10.0/src/commands/login.js)_

## `apify logout`

Expand All @@ -449,7 +449,7 @@ DESCRIPTION
call "apify login".
```

_See code: [src/commands/logout.js](https://github.com/apify/apify-cli/blob/v0.9.0/src/commands/logout.js)_
_See code: [src/commands/logout.js](https://github.com/apify/apify-cli/blob/v0.10.0/src/commands/logout.js)_

## `apify push [ACTORID]`

Expand Down Expand Up @@ -484,7 +484,7 @@ DESCRIPTION
WARNING: If the target actor already exists in your Apify account, it will be overwritten!
```

_See code: [src/commands/push.js](https://github.com/apify/apify-cli/blob/v0.9.0/src/commands/push.js)_
_See code: [src/commands/push.js](https://github.com/apify/apify-cli/blob/v0.10.0/src/commands/push.js)_

## `apify run`

Expand Down Expand Up @@ -514,7 +514,7 @@ DESCRIPTION
can set up your own main file or environment variables by changing it.
```

_See code: [src/commands/run.js](https://github.com/apify/apify-cli/blob/v0.9.0/src/commands/run.js)_
_See code: [src/commands/run.js](https://github.com/apify/apify-cli/blob/v0.10.0/src/commands/run.js)_

## `apify secrets`

Expand All @@ -540,7 +540,7 @@ DESCRIPTION
of the actor.
```

_See code: [src/commands/secrets/index.js](https://github.com/apify/apify-cli/blob/v0.9.0/src/commands/secrets/index.js)_
_See code: [src/commands/secrets/index.js](https://github.com/apify/apify-cli/blob/v0.10.0/src/commands/secrets/index.js)_

## `apify secrets:add NAME VALUE`

Expand All @@ -558,7 +558,7 @@ DESCRIPTION
The secrets are stored to a file at ~/.apify
```

_See code: [src/commands/secrets/add.js](https://github.com/apify/apify-cli/blob/v0.9.0/src/commands/secrets/add.js)_
_See code: [src/commands/secrets/add.js](https://github.com/apify/apify-cli/blob/v0.10.0/src/commands/secrets/add.js)_

## `apify secrets:rm NAME`

Expand All @@ -572,7 +572,7 @@ ARGUMENTS
NAME Name of the secret
```

_See code: [src/commands/secrets/rm.js](https://github.com/apify/apify-cli/blob/v0.9.0/src/commands/secrets/rm.js)_
_See code: [src/commands/secrets/rm.js](https://github.com/apify/apify-cli/blob/v0.10.0/src/commands/secrets/rm.js)_

## `apify vis [PATH]`

Expand All @@ -586,5 +586,5 @@ ARGUMENTS
PATH Optional path to your INPUT_SCHEMA.json file. If not provided ./INPUT_SCHEMA.json is used.
```

_See code: [src/commands/vis.js](https://github.com/apify/apify-cli/blob/v0.9.0/src/commands/vis.js)_
_See code: [src/commands/vis.js](https://github.com/apify/apify-cli/blob/v0.10.0/src/commands/vis.js)_
<!-- commandsstop -->
34 changes: 17 additions & 17 deletions npm-shrinkwrap.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit fe472f2

Please sign in to comment.