Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prepare release v0.5.0 #80

Merged
merged 5 commits into from
Jun 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,28 @@ All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/).

## [0.5.0] - 2024-06-22

### Added

- Add validation rule to IWC profile to check all steps are documented [#79](https://github.com/davelopez/galaxy-workflows-vscode/pull/79)
- Handle union types in Format2 Schema [#76](https://github.com/davelopez/galaxy-workflows-vscode/pull/76)

### Changed

- Improve validation profiles [#71](https://github.com/davelopez/galaxy-workflows-vscode/pull/71)
- Improve symbols provider [#70](https://github.com/davelopez/galaxy-workflows-vscode/pull/70)
- Improve document detection [#69](https://github.com/davelopez/galaxy-workflows-vscode/pull/69)

### Fixed

- Fix some completion edge cases in Format2 [#78](https://github.com/davelopez/galaxy-workflows-vscode/pull/78)
- Ignore auto-complete suggestions for some schema elements in Format2 [#77](https://github.com/davelopez/galaxy-workflows-vscode/pull/77)
- Fix Format2 validation for Any type [#75](https://github.com/davelopez/galaxy-workflows-vscode/pull/75)
- Fix Format2 compatible primitive types validation [#74](https://github.com/davelopez/galaxy-workflows-vscode/pull/74)
- Fix duplicated document cache on remote GitHub repositories [#73](https://github.com/davelopez/galaxy-workflows-vscode/pull/73)
- Fix step export error validation rule [#72](https://github.com/davelopez/galaxy-workflows-vscode/pull/72)

## [0.4.0] - 2024-06-02

### Added
Expand Down
46 changes: 28 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,17 @@
# Galaxy Workflows VSCode Extension

[![License: MIT](https://img.shields.io/badge/License-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT)
![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/davelopez/galaxy-workflows-vscode)
[![CI](https://github.com/davelopez/galaxy-workflows-vscode/actions/workflows/main.yml/badge.svg)](https://github.com/davelopez/galaxy-workflows-vscode/actions/workflows/main.yml)
[![Open in Visual Studio Code](https://img.shields.io/static/v1?logo=visualstudiocode&label=&message=Open%20in%20Visual%20Studio%20Code&labelColor=2c2c32&color=007acc&logoColor=007acc)](https://open.vscode.dev/davelopez/galaxy-workflows-vscode)
<a href="https://opensource.org/licenses/MIT" style="margin-right: 5px;">
<img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-brightgreen.svg?link=https%3A%2F%2Fopensource.org%2Flicenses%2FMIT">
</a>
<a href="https://github.com/davelopez/galaxy-workflows-vscode/releases" style="margin-right: 5px;">
<img alt="GitHub Release" src="https://img.shields.io/github/v/release/davelopez/galaxy-workflows-vscode">
</a>
<a href="https://github.com/davelopez/galaxy-workflows-vscode/actions/workflows/main.yml" style="margin-right: 5px;">
<img alt="CI" src="https://github.com/davelopez/galaxy-workflows-vscode/actions/workflows/main.yml/badge.svg">
</a>
<a href="https://open.vscode.dev/davelopez/galaxy-workflows-vscode">
<img alt="Open in Visual Studio Code" src="https://img.shields.io/static/v1?logo=visualstudiocode&label=&message=Open%20in%20Visual%20Studio%20Code&labelColor=2c2c32&color=007acc&logoColor=007acc">
</a>

The **Galaxy Workflows VSCode extension** assists in editing [Galaxy](https://galaxyproject.org/) Workflow files while enforcing [best practices](https://planemo.readthedocs.io/en/latest/best_practices_workflows.html). Use it in combination with [Planemo](https://github.com/galaxyproject/planemo) for an optimal experience in developing and maintaining your Galaxy workflows.

Expand All @@ -29,7 +37,9 @@ If you find a bug or have a suggestion to improve your experience, please create

1. For example, open the IWC (_Intergalactic Workflow Commission_) repository on GitHub

[![Open in Visual Studio Code](https://img.shields.io/static/v1?logo=visualstudiocode&label=&message=Open%20IWC%20repository%20in%20Visual%20Studio%20Code&labelColor=2c2c32&color=007acc&logoColor=007acc)](https://vscode.dev/github/galaxyproject/iwc)
<a href="https://vscode.dev/github/galaxyproject/iwc">
<img alt="Open IWC repository in Visual Studio Code" src="https://img.shields.io/static/v1?logo=visualstudiocode&label=&message=Open%20IWC%20repository%20in%20Visual%20Studio%20Code&labelColor=2c2c32&color=007acc&logoColor=007acc)](https://vscode.dev/github/galaxyproject/iwc">
</a>

2. Install the extension if you haven't already:

Expand Down Expand Up @@ -84,11 +94,11 @@ You will receive diagnostics for every syntax error or incorrect property value

#### Gxformat2 (yaml)

![Workflow Validation Demo](images/validation-gxformat2.gif)
<img alt="Workflow Validation Demo" src="https://raw.githubusercontent.com/davelopez/galaxy-workflows-vscode/main/images/validation-gxformat2.gif" width=1215 height=auto>

#### Legacy (ga)

![Workflow Validation Demo](images/validation-native.gif)
<img alt="Workflow Validation Demo" src="https://raw.githubusercontent.com/davelopez/galaxy-workflows-vscode/main/images/validation-native.gif" width=1024 height=auto>

[Back to Features ⬆️](#features)

Expand All @@ -98,11 +108,11 @@ Hover over properties to get a description of what they are and how to use them.

#### Gxformat2 (yaml)

![Documentation on Hover Demo](images/doc-hover-gxformat2.gif)
<img alt="Documentation on Hover Demo" src="https://raw.githubusercontent.com/davelopez/galaxy-workflows-vscode/main/images/doc-hover-gxformat2.gif" width=877 height=auto>

#### Legacy (ga)

![Documentation on Hover Demo](images/doc-hover-native.gif)
<img alt="Documentation on Hover Demo" src="https://raw.githubusercontent.com/davelopez/galaxy-workflows-vscode/main/images/doc-hover-native.gif" width=699 height=auto>

[Back to Features ⬆️](#features)

Expand All @@ -112,11 +122,11 @@ Get [IntelliSense](https://code.visualstudio.com/docs/editor/intellisense#:~:tex

#### Gxformat2 (yaml)

![IntelliSense Demo](images/intellisense-gxformat2.gif)
<img alt="IntelliSense Demo" src="https://raw.githubusercontent.com/davelopez/galaxy-workflows-vscode/main/images/intellisense-gxformat2.gif" width=760 height=auto>

#### Legacy (ga)

![IntelliSense Demo](images/intellisense-native.gif)
<img alt="IntelliSense Demo" src="https://raw.githubusercontent.com/davelopez/galaxy-workflows-vscode/main/images/intellisense-native.gif" width=785 height=auto>

[Back to Features ⬆️](#features)

Expand All @@ -126,11 +136,11 @@ Keep your workflow document consistently formatted. We recommend enabling the VS

#### Gxformat2 (yaml)

![Auto Formatting Demo](images/format-document-gxformat2.gif)
<img alt="Auto Formatting Demo" src="https://raw.githubusercontent.com/davelopez/galaxy-workflows-vscode/main/images/format-document-gxformat2.gif" width=759 height=auto>

#### Legacy (ga)

![Auto Formatting Demo](images/format-document-native.gif)
<img alt="Auto Formatting Demo" src="https://raw.githubusercontent.com/davelopez/galaxy-workflows-vscode/main/images/format-document-native.gif" width=1024 height=auto>

[Back to Features ⬆️](#features)

Expand All @@ -140,11 +150,11 @@ The `Custom Outline` allows you to navigate and find different parts of the Work

#### Gxformat2 (yaml)

![Custom Outline Demo](images/custom-outline-gxformat2.gif)
<img alt="Custom Outline Demo" src="https://raw.githubusercontent.com/davelopez/galaxy-workflows-vscode/main/images/custom-outline-gxformat2.gif" width=1255 height=auto>

#### Legacy (ga)

![Custom Outline Demo](images/custom-outline-native.gif)
<img alt="Custom Outline Demo" src="https://raw.githubusercontent.com/davelopez/galaxy-workflows-vscode/main/images/custom-outline-native.gif" width=1024 height=auto>

[Back to Features ⬆️](#features)

Expand All @@ -154,7 +164,7 @@ You can clean up the non-essential properties of a (legacy .ga) workflow with th

#### Legacy (ga)

![Cleanup Command Demo](images/clean-up-command-native.gif)
<img alt="Cleanup Command Demo" src="https://raw.githubusercontent.com/davelopez/galaxy-workflows-vscode/main/images/clean-up-command-native.gif" width=1024 height=auto>

[Back to Features ⬆️](#features)

Expand All @@ -169,12 +179,12 @@ Sometimes you want to compare different revisions of the same (legacy .ga) workf

#### Legacy (ga)

![Simplified Workflow Diffs Demo](images/clean-diff-native.gif)
<img alt="Simplified Workflow Diffs Demo" src="https://raw.githubusercontent.com/davelopez/galaxy-workflows-vscode/main/images/clean-diff-native.gif" width=1317 height=auto>

### Workflow Tests Document Support

You can now edit Workflow Test Files (`*-test.yml`) with basic language support. This includes syntax highlighting, validation, auto-completion, and documentation on hover based on the _experimental_ schema for Workflow Test Files.

![Workflow Tests Document Support Demo](images/workflow-test-documents-support.gif)
<img alt="Workflow Tests Document Support Demo" src="https://raw.githubusercontent.com/davelopez/galaxy-workflows-vscode/main/images/workflow-test-documents-support.gif" width=1315 height=auto>

[Back to Features ⬆️](#features)
32 changes: 16 additions & 16 deletions package-lock.json

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

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "galaxy-workflows",
"displayName": "Galaxy Workflows",
"description": "Utilities to assist in the edition of Galaxy (https://galaxyproject.org/) Workflow files.",
"version": "0.4.0",
"version": "0.5.0",
"preview": true,
"license": "MIT",
"publisher": "davelopez",
Expand Down