README.md in workato-connector-sdk-0.1.1 vs README.md in workato-connector-sdk-0.1.2
- old
+ new
@@ -13,10 +13,11 @@
## Prerequisites
1. Install [RVM ("Ruby Version Manager")](http://rvm.io/) or a Ruby manager of your choice. You can find more at [here](https://www.ruby-lang.org/en/documentation/installation/)
2. Choose between Ruby versions `2.4.10` `2.5.X` or `2.7.X`. Our preferred version is `2.7.X`.
3. Verify you're running a valid ruby version. Do this by running either `ruby -v` or the commands within your version manager. i.e., `rvm current` if you have installed RVM.
+4. For Windows you need tzinfo-data gem installed as well. `gem install tzinfo-data`
```bash
ruby -v
Output:
ruby 2.7.X
@@ -36,11 +37,11 @@
workato edit <PATH> # Edit encrypted file, e.g. settings.yaml.enc
workato exec <PATH> # Execute connector defined block
workato generate <SUBCOMMAND> # Generates code from template
workato help [COMMAND] # Describe available commands or one specific command
workato new <CONNECTOR_PATH> # Inits new connector folder
- workato push <FOLDER> # Upload and release connector's code
+ workato push # Upload and release connector's code
Options:
[--verbose], [--no-verbose]
```
@@ -122,15 +123,15 @@
### 2.4 Gemfile.lock
You don't need to create this file. It'll be created later on. This file just holds a store of all the dependencies you have, their versions, and also the dependencies your dependencies might have.
### 2.5 README.MD
This file shows up on your Github project (or other Git software you use). Use it to document what your connector does! **Not created via `workato new <PATH>` commands.**
-When you use the `workato push <FOLDER>` command to sync your connector with your Workato workspace, this is the default file for your connector's description.
+When you use the `workato push` command to sync your connector with your Workato workspace, this is the default file for your connector's description.
### 2.6 logo.png
The logo of your connector. **Not created via `workato new <PATH>` commands.**
-When you use the `workato push <FOLDER>` command to sync your connector with your Workato workspace, this is the default file for your connector's logo.
+When you use the `workato push` command to sync your connector with your Workato workspace, this is the default file for your connector's logo.
### 2.7 connector.rb
Well, this is your actual connector code. This file should be a replica of your connector code in Workato.
### 2.8 master.key
@@ -221,11 +222,11 @@
workato edit <PATH> # Edit encrypted file, e.g. settings.yaml.enc
workato exec <PATH> # Execute connector defined block
workato generate <SUBCOMMAND> # Generates code from template
workato help [COMMAND] # Describe available commands or one specific command
workato new <CONNECTOR_PATH> # Inits new connector folder
- workato push <FOLDER> # Upload and release connector's code
+ workato push # Upload and release connector's code
Options:
[--verbose], [--no-verbose]
```
@@ -360,11 +361,11 @@
### 3.6 workato push
```
workato help push
Usage:
- workato push <FOLDER>
+ workato push
Options:
-t, [--title=TITLE] # Connector title on the Workato Platform
-d, [--description=DESCRIPTION] # Path to connector description: Markdown or plain text
-l, [--logo=LOGO] # Path to connector logo: png or jpeg file
@@ -373,11 +374,12 @@
[--api-email=API_EMAIL] # Email for accessing Workato API or set WORKATO_API_EMAIL env
[--api-token=API_TOKEN] # Token for accessing Workato API or set WORKATO_API_TOKEN env
[--environment=ENVIRONMENT] # Server to push connector code to
# Default: live
# Possible values: preview, preview-eu, live, live-eu
- [--verbose], [--no-verbose]
+ [--folder=FOLDER] # Folder ID if you what to push to folder other than Home
+ [--verbose], [--no-verbose]
Upload and release connector's code
```
This allows you to push your connector code from your connector project locally to your workspace. This allows you to quickly cycle from testing connector functionality and the UX of your connector.
@@ -1084,10 +1086,9 @@
run: bundle exec rspec
# - name: Push to DEV workspace # Use this to push to DEV. This can be enabled when a PR is merged.
# env:
# WORKATO_API_EMAIL: ${{ secrets.WORKATO_DEV_ENVIRONMENT_API_EMAIL}}
# WORKATO_API_TOKEN: ${{ secrets.WORKATO_DEV_ENVIRONMENT_API_TOKEN}}
- # WORKATO_API_FOLDER: ${{ secrets.WORKATO_DEV_ENVIRONMENT_API_HOME_FOLDER}}
- # run: workato push $WORKATO_API_FOLDER
+ # run: workato push
```
You may also add more Github actions for rubocop to automate this.
\ No newline at end of file