Skip to content

Commit

Permalink
Fixing some of the guides and READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
@custompointofview
custompointofview committed Jan 11, 2024
1 parent 45a3d84 commit 3ef2984
Show file tree
Hide file tree
Showing 3 changed files with 63 additions and 72 deletions.
100 changes: 41 additions & 59 deletions robocorp-code/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,59 +1,43 @@
## Robocorp VS Code extension

The Robocorp extension makes it easy to create Python or Robot Framework based automation projects and software robots.
The Robocorp extension makes it easy to create Python based automation projects.

You can use this extension as part of the [Robocorp Automation Stack](https://github.com/robocorp/rcc), which has been optimized for tasks such as robotic process automation (RPA), web scraping and IT automation. It scales up from simple image fetching or API calling all the way to complex process automation workflows.

Main features include:

- **Automatic configuration of dependencies**, including Python and Robot Framework. Every project uses its own lightweight virtual environment and runs in isolation.
- **Automatic configuration of dependencies** - Every Python oriented project uses its own lightweight virtual environment and runs in isolation.

- **Automatic configuration of language server** for syntax highlighting and code completion in Robot Framework.
- **Inspector for Web, Windows Application Elements & more** - Pick elements from different mediums and create locators for automation

- **Create, run and debug projects**.
- **Create, run and debug projects** - Do these with ease while developing Tasks to automate applications

- **Deploy projects to Robocorp Cloud**.
- **Deploy projects to Robocorp Cloud** - Run unattended automation in a safe, reliable and easy to use Cloud Platform.


Note: the use of cloud-based orchestration in [Robocorp Cloud](https://robocorp.com/robocorp-cloud) requires a free account.
> Note: the use of cloud-based orchestration in [Robocorp Cloud](https://robocorp.com/robocorp-cloud) requires a free account.
![Example of a Robot running with the extension](images/gif_run.gif)


### Get Started

1. Install this extension together with the [Robot Framework Language Server extension](https://marketplace.visualstudio.com/items?itemName=robocorp.robotframework-lsp).

1. Download [Robocorp VS Code extension - basic tutorial](https://robocorp.com/portal/robot/robocorp/example-vscode-basics), and open it in VS Code.

1. Open the command palette - (Windows, Linux): `ctrl-shift-P` (macOS): `cmd-shift-P`

1. select the command `Robocorp: Run Robot`

1. Select the task to run (only if the robot contains more than one task).

More examples are available at https://robocorp.com/robots/.
2. Open the command palette - (Windows, Linux): `CTRL-SHIFT-P` (macOS): `CMD-SHIFT-P`

You can also find a video tutorial on the [YouTube Robocorp channel](https://youtu.be/zQQl8xZkGko?list=PLfXJKwwF049DIZxvwYuBgahHcDDGPpfN6).

Full instructions are available at [https://robocorp.com/docs/product-manuals/robocorp-code](https://robocorp.com/docs/product-manuals/robocorp-code).

### Features
3. Select the command `Robocorp: Run Robot`

![image of command palette](images/command-palette.png)

- Create robots based on templates.

- Run Robots in virtual environments.
4. Select the Task to run (only if the Task Package contains more than one task).

- Run Robots locally with VSCode run configuration.
> Note: You can do the same actions from the side bar after opening the Extension tab in VS Code.
- Debug Robots
Find more examples and tutorials at the [Robocorp Portal](https://robocorp.com/robots/).
You can also find helpful videos on the [YouTube Robocorp channel](https://youtu.be/zQQl8xZkGko?list=PLfXJKwwF049DIZxvwYuBgahHcDDGPpfN6).

- Deploy robots to Robocorp Cloud

We are actively developing the extension, [contact us](#Reporting-Issues) for issues and feature requests.
Full instructions are available at the [Product Manual](https://robocorp.com/docs/product-manuals/robocorp-code) for the VS Code Extension.

This is under active development, so please [contact us](#Reporting-Issues) for issues and feature requests.

### Requirements

Expand All @@ -69,41 +53,39 @@ Find the full installation instructions at [https://robocorp.com/docs/product-ma

During the first activation, the extension will download additional dependencies (such as Conda manager) that are required for it to run.

### Features (1.14.0)

- Preliminary support for [Robo](https://github.com/robocorp/robo) (Robocorp's Python Framework for automation).
- Ctrl+Click on terminal for the 'Robocorp html Log` opens external browser.
- Code Lenses to `Run Task` / `Debug Task` for tasks decorated with `@task`.
- `ROBO TASKS OUTPUT` which shows the output of tasks run with `@task`.
- Support for [Work Items](https://robocorp.com/docs/developer-tools/visual-studio-code/extension-features#using-work-items).
- Automatic bootstrapping of the Python environment for the `Robot Framework Language Server`.
- Create a Robot from a pre-configured template using the `Robocorp: Create Robot` action.
- Upload a Robot to the cloud with the `Robocorp: Upload Robot to the Robocorp Cloud` action.
- Link to the cloud with the `Robocorp: Link to Robocorp Cloud` action.
- Unlink from the cloud with the `Robocorp: Unlink and remove credentials from Robocorp Cloud` action.
- Verify Robot for inconsistencies with `Robocorp: Robot Configuration Diagnostics` action.
- Create a terminal with a Robot environment through the `Robocorp: Terminal with Robot environment` action.
- Run a Robot with the `Robocorp: Run Robot` action.
- Debug a Robot with the `Robocorp: Debug Robot` action. - It's possible to debug plain Python tasks using the Python extension or Robot Framework tasks using the Robot Framework Language Server (in which case the task must start with `python -m robot` and finish with the folder/filename to be run).
- When a [robot.yaml](https://robocorp.com/docs/setup/robot-yaml-format) is found, it utilises the related Python environment when running/debugging `.robot` files using the RobotFramework Language Server.
- Set the pythonPath configuration to get code completion in the Python extension through the `Set pythonPath based on robot.yaml` action.
- View, launch and debug Robots from the `Robots` view.
- View and create new [Browser Locators](https://robocorp.com/docs/development-howtos/browser/how-to-find-user-interface-elements-using-locators-in-web-applications) from the `Locators` view.
- View and create new [Image Locators](https://robocorp.com/docs/product-manuals/robocorp-lab/locating-and-targeting-user-interface-elements-in-robocorp-lab) from the `Locators` view.
- When hovering over a `"screenshot"`, `"path"` or `"source"` element in the `locators.json`, a preview is shown.
- Send issue reports with the `Robocorp: Submit issue` action.
### Features (1.14.1)

- Preliminary support for [Robo](https://github.com/robocorp/robo) (Robocorp's Python Framework for automation).
- Ctrl+Click on terminal for the 'Robocorp html Log` opens external browser.
- Code Lenses to `Run Task` / `Debug Task` for tasks decorated with `@task`.
- `ROBO TASKS OUTPUT` which shows the output of tasks run with `@task`.
- Support for [Work Items](https://robocorp.com/docs/developer-tools/visual-studio-code/extension-features#using-work-items).
- Automatic bootstrapping of the Python environment for the `Robot Framework Language Server`.
- Create a Robot from a pre-configured template using the `Robocorp: Create Robot` action.
- Upload a Robot to the cloud with the `Robocorp: Upload Robot to the Robocorp Cloud` action.
- Link to the cloud with the `Robocorp: Link to Robocorp Cloud` action.
- Unlink from the cloud with the `Robocorp: Unlink and remove credentials from Robocorp Cloud` action.
- Verify Robot for inconsistencies with `Robocorp: Robot Configuration Diagnostics` action.
- Create a terminal with a Robot environment through the `Robocorp: Terminal with Robot environment` action.
- Run a Robot with the `Robocorp: Run Robot` action.
- Debug a Robot with the `Robocorp: Debug Robot` action. - It's possible to debug plain Python tasks using the Python extension or Robot Framework tasks using the Robot Framework Language Server (in which case the task must start with `python -m robot` and finish with the folder/filename to be run).
- When a [robot.yaml](https://robocorp.com/docs/setup/robot-yaml-format) is found, it utilises the related Python environment when running/debugging `.robot` files using the RobotFramework Language Server.
- Set the pythonPath configuration to get code completion in the Python extension through the `Set pythonPath based on robot.yaml` action.
- View, launch and debug Robots from the `Robots` view.
- View and create new [Browser Locators](https://robocorp.com/docs/development-howtos/browser/how-to-find-user-interface-elements-using-locators-in-web-applications) from the `Locators` view.
- View and create new [Image Locators](https://robocorp.com/docs/product-manuals/robocorp-lab/locating-and-targeting-user-interface-elements-in-robocorp-lab) from the `Locators` view.
- When hovering over a `"screenshot"`, `"path"` or `"source"` element in the `locators.json`, a preview is shown.
- Send issue reports with the `Robocorp: Submit issue` action.
- Robocorp Inspector is now integrated within the extension - access it from the side bar or via command palette

### Developing

See: [Developing](docs/develop.md) for details on how to develop the `Robocorp Code` extension.

### Reporting Issues

Issues may be reported at: [https://github.com/robocorp/robotframework-lsp/issues/new/choose](https://github.com/robocorp/robotframework-lsp/issues/new/choose).

Forum: https://forum.robocorp.com/
Issues may be reported in the [GitHub Issues](https://github.com/robocorp/robotframework-lsp/issues/new/choose).

Slack: robocorp-developers.slack.com
Contact us via Slack: [robocorp-developers.slack.com](https://robocorp-developers.slack.com/ssb/redirect)

License: Apache 2.0
---
## License: Apache 2.0
27 changes: 18 additions & 9 deletions robocorp-code/docs/changelog.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
New in 1.14.1 (2024-01-11)
-----------------------------

- Several improvements to the Robocorp Inspector
- Note: First experimental version, looking for feedback!
- Renaming to the new terminology for the Side Bar
- Note: Part of moving to Task Packages & Tasks & Actions


New in 1.14.0 (2023-12-21)
-----------------------------

Expand All @@ -22,7 +31,7 @@ New in 1.11.0 (2023-09-07)
- When hovering over conda dependencies in `conda.yaml`, information from conda-forge is shown.
- Warning if the versions for conda-forge in `conda.yaml` have updates.
- RCC is now distributed along with `Robocorp Code` (so, it'll no longer be downloaded in the first activation).
- A warning is no longer shown if a pre-release is available in pypi and the latest version is actually being used already.
- A warning is no longer shown if a pre-release is available in pypi and the latest version is actually being used already.
- Fixed issue where a parse exception was shown when a git url was used to install a pip dependency.
- Fixed issue where a method decorated with `@task_cache` would have code lenses which should only appear to `@task`.

Expand All @@ -38,7 +47,7 @@ New in 1.10.0 (2023-08-21)
- `ROBO TASKS OUTPUT` updated to latest version:
- Support for `robocorp-log 2.7.0`:
- `if` statements now create a scope in `log.html` (when the function is not a generator).
- If an exception has a cause or context the context/cause is now shown in the log
- If an exception has a cause or context the context/cause is now shown in the log
- (i.e.: when an exception is raised from another exception or is raised while handling another exception all exceptions are shown).
- `continue` and `break` inside a loop are properly handled.
- `continue` and `break` are now shown in the logs.
Expand Down Expand Up @@ -84,7 +93,7 @@ New in 1.6.0 (2023-07-10)

- Updated `ROBO TASKS OUTPUT` so that places showing the file/line of messages are now clickable and
can be used to open the file location inside of VSCode.

- In the `ROBO TASKS OUTPUT`, it's possible to view log messages along with the terminal
output.

Expand Down Expand Up @@ -171,7 +180,7 @@ New in 1.0.0 (2023-01-16)
- When specifying the timeout for the vault, the token is guaranteed to have that as the minimum value (in previous versions it could reuse it for `75%` of the time, so, a `2h` timeout request could return a `0:30h` minutes token).
- Timeout limits are now in place so that the minimum timeout is 5 minutes and maximum is 1 hour (but the token requested may be a bit higher so that the extension can cache it and reuse it for more time).
- Note: if a longer timeout is needed for testing, a managed environment such as `Robocorp Control Room` or `Robocorp Assistant` is recommended.


New in 0.43.0 (2023-01-05)
-----------------------------
Expand All @@ -185,7 +194,7 @@ New in 0.42.0 (2022-12-22)

- RCC was upgraded to `v11.36.3`.
- No longer showing warnings regarding locks at startup.
- It's now possible to proceed even with long paths disabled.
- It's now possible to proceed even with long paths disabled.
- New setting: `robocorp.vaultTokenTimeoutInMinutes` can be used to change the timeout for the token used for vault access when launching.


Expand All @@ -199,7 +208,7 @@ New in 0.41.0 (2022-12-13)
New in 0.40.2 (2022-12-05)
-----------------------------

- Fixed regression where `noDebug` was not being properly set in generated launch.
- Fixed regression where `noDebug` was not being properly set in generated launch.


New in 0.40.1 (2022-12-03)
Expand Down Expand Up @@ -239,7 +248,7 @@ New in 0.37.0 (2022-09-14)
- Improved UI for submit issue.
- RCC was upgraded to `v11.26.3`.
- Locators:
- `robocorp-inspector` was upgraded to `0.7.1`.
- `robocorp-inspector` was upgraded to `0.7.1`.
- Added recording functionality to command palette


Expand All @@ -255,8 +264,8 @@ New in 0.35.0 (2022-07-04)
-----------------------------

- `RCC` was upgraded to to `v11.14.5`.
- RCC is now configured to put the holotree contents in a location shared by multiple users (which allows
for the import of pre-created environments from a .zip file).
- RCC is now configured to put the holotree contents in a location shared by multiple users (which allows
for the import of pre-created environments from a .zip file).
- The base environment created for the extension bootstrap is now imported from a base environment downloaded from .zip
(which is *much* faster).

Expand Down
8 changes: 4 additions & 4 deletions robocorp-code/docs/release.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,17 @@ To release a new version:

- Open a shell at the proper place (something as `X:\robocorpws\robotframework-lsp\robocorp-code`)

- Create release branch (`git branch -D release-robocorp-code&git checkout -b release-robocorp-code`)
- Create release branch (`git branch -D release-robocorp-code & git checkout -b release-robocorp-code`)

- Update version (`python -m dev set-version 1.14.0`).
- Update version (`python -m dev set-version 1.14.1`).

- Update README.md to add notes on features/fixes.

- Update changelog.md to add notes on features/fixes and set release date.

- Push contents to release branch, get the build in https://github.com/robocorp/robotframework-lsp/actions and install locally to test.
- `mu acp Release Robocorp Code 1.14.0`
- `mu acp Release Robocorp Code 1.14.1`

- Rebase with master (`git checkout master&git rebase release-robocorp-code`).

- Create a tag (`git tag robocorp-code-1.14.0`) and push it.
- Create a tag (`git tag robocorp-code-1.14.1`) and push it.

0 comments on commit 3ef2984

Please sign in to comment.