Skip to content

Commit

Permalink
Update CHANGELOG.md (#129)
Browse files Browse the repository at this point in the history
* Update CHANGELOG.md

* Update CHANGELOG.md

Co-authored-by: Juan Luis Cano Rodríguez <[email protected]>

* update readme

Signed-off-by: Nok <[email protected]>

---------

Signed-off-by: Nok <[email protected]>
Co-authored-by: Juan Luis Cano Rodríguez <[email protected]>
  • Loading branch information
noklam and astrojuanlu authored Oct 2, 2024
1 parent 47e7b0f commit d0b3f95
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 21 deletions.
9 changes: 6 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
# Change Log

# 0.2.2
- Reduce size of packaged artifacts.

# 0.2.1
- Added a new command `Kedro: Show logs` for troubleshooting.

# 0.2.0 (pre-release)
## Major changes and new features
- Integrated Kedro-Viz flowchart into the extension with a new command `Kedro: Run Kedro Viz`.
- Modified the extension to search pipelines from all `<package_name>/pipelines` folder.

- Added new command`Kedro
- Added new command `Kedro: Show Logs`
## Bug fix
- `Select Environment` actions now update the run environment instead of base.
- Modified status bar to show both environments, i.e.`base + local`, and `base` is no longer selectable.
Expand All @@ -33,4 +36,4 @@
- Fix a **startup** error bug.

# 0.0.1
- Support basic go to definition
- Support basic go to definition
27 changes: 11 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,13 +70,22 @@ Type `"` in any `pipeline.py` and it should trigger the autocompletion list.
Just hover your mouse over any `params:`, datasets or hit the command `Show or Focus Hover`
![hover](assets/lsp-hover.gif)

## To navigate between the flowchart and the code editor in Kedro-Viz:
## To navigate between the flowchart and the code editor with Kedro-Viz:
To visualize your Kedro project using Kedro-Viz in Visual Studio Code, follow these steps:

1. **Open the Command Palette**:
Press `Cmd` + `Shift` + `P` (on macOS) or `Ctrl` + `Shift` + `P` (on Windows/Linux).

2. **Run Kedro-Viz**:
Type `kedro: Run Kedro Viz` and select the command.
This will launch Kedro-Viz and display your pipeline visually within the extension.

**Note:** To update the Kedro-Viz flowchart after making any changes to your Kedro project, please hit `Cmd` + `Shift` + `P` to open the VSCode command and look for `kedro: restart server`.

Navigate to Node Functions:
Click on a node in the Kedro-Viz flowchart, and it will automatically navigate to the corresponding node function in your code.
![navigation to node function](assets/viz-vsc-nav-function-node.gif)


Navigate to DataCatalog:
Clicking on a data node in the flowchart will open the corresponding dataset in the Data Catalog.
![navigation to dataset](assets/viz-vsc-nav-data-node.gif)
Expand Down Expand Up @@ -123,20 +132,6 @@ The extension follows Kedro [pipeline autodiscovery mechanism](https://docs.kedr
```

## Visualisation with Kedro-Viz
To visualize your Kedro project using Kedro-Viz in Visual Studio Code, follow these steps:

1. **Open the Command Palette**:
Press `Cmd` + `Shift` + `P` (on macOS) or `Ctrl` + `Shift` + `P` (on Windows/Linux).

2. **Run Kedro-Viz**:
Type `kedro: Run Kedro Viz` and select the command.
This will launch Kedro-Viz and display your pipeline visually within the extension.

![start kedro viz](assets/viz-vsc-start.gif)

**Note:** To update the Kedro-Viz flowchart after making any changes to your Kedro project, please hit `Cmd` + `Shift` + `P` to open the VSCode command and look for `kedro: restart server`.

## Troubleshooting
In VSCode, you can check the `Output` tab next to your terminal and select `Kedro` to read the logs.

Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

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

0 comments on commit d0b3f95

Please sign in to comment.