Skip to content
This repository has been archived by the owner on Mar 31, 2021. It is now read-only.

Commit

Permalink
Rename plugin name to sql-workbench (#72)
Browse files Browse the repository at this point in the history
* renamed artifact

* update
  • Loading branch information
chloe-zh authored May 21, 2020
1 parent 68e16df commit fa7ac34
Show file tree
Hide file tree
Showing 9 changed files with 66 additions and 61 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/release-workflow.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

name: Release SQL-Kibana Artifacts
name: Release SQL-Workbench Artifacts

on:
push:
Expand Down Expand Up @@ -32,7 +32,7 @@ jobs:
- name: Checkout Plugin
uses: actions/checkout@v1
with:
path: kibana/plugins/sql-kibana-plugin
path: kibana/plugins/sql-workbench

- name: Setup Node
uses: actions/setup-node@v1
Expand All @@ -51,5 +51,5 @@ jobs:
yarn build
artifact=`ls ./build/*.zip`
aws s3 cp $artifact s3://artifacts.opendistroforelasticsearch.amazon.com/downloads/kibana-plugins/opendistro-sql-kibana/
aws s3 cp $artifact s3://artifacts.opendistroforelasticsearch.amazon.com/downloads/kibana-plugins/opendistro-sql-workbench/
aws cloudfront create-invalidation --distribution-id ${{ secrets.DISTRIBUTION_ID }} --paths "/downloads/*"
4 changes: 2 additions & 2 deletions .github/workflows/test-and-build-workflow.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:
- name: Checkout Plugin
uses: actions/checkout@v1
with:
path: kibana/plugins/sql-kibana-plugin
path: kibana/plugins/sql-workbench
- name: Setup Node
uses: actions/setup-node@v1
with:
Expand All @@ -39,5 +39,5 @@ jobs:
- name: Upload Artifact
uses: actions/upload-artifact@v1
with:
name: sql-kibana
name: sql-workbench
path: ./build
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ information to effectively respond to your bug report or contribution.

We welcome you to use the GitHub issue tracker to report bugs or suggest features.

When filing an issue, please check [existing open](https://github.com/open-distro-for-elasticsearch/sql-kibana-plugin/issues), or [recently closed](https://github.com/open-distro-for-elasticsearch/sql-kibana-plugin/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already
When filing an issue, please check [existing open](https://github.com/opendistro-for-elasticsearch/sql-workbench/issues), or [recently closed](https://github.com/opendistro-for-elasticsearch/sql-workbench/issues?q=is%3Aissue+is%3Aclosed), issues to make sure somebody else hasn't already
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:

* A reproducible test case or series of steps
Expand Down Expand Up @@ -41,7 +41,7 @@ GitHub provides additional document on [forking a repository](https://help.githu


## Finding contributions to work on
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/open-distro-for-elasticsearch/sql-kibana-plugin/labels/help%20wanted) issues is a great place to start.
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any issue tagged ["good first issue"](https://github.com/opendistro-for-elasticsearch/sql-workbench/issues?q=is%3Aopen+label%3A%22help+wanted%22+label%3A%22good+first+issue%22) is a great place to start.


## Code of Conduct
Expand Down
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# Open Distro for Elasticsearch
Workbench
# Open Distro for Elasticsearch SQL Workbench

The Open Distro for Elasticsearch SQL Workbench enables you to query your Elasticsearch data using SQL syntax from a dedicated Kibana UI. You can download your query results data in JSON, JDBC, CSV and raw text formats.

Expand All @@ -20,23 +19,23 @@ Please see our technical [documentation](https://opendistro.github.io/for-elasti
1. Change your node version to the version specified in `.node-version` inside the Kibana root directory.
1. cd into `plugins` directory in the Kibana source code directory.
1. Check out this package from version control into the `plugins` directory.
1. Run `yarn kbn bootstrap` inside `kibana/plugins/sql-kibana-plugin`.
1. Run `yarn kbn bootstrap` inside `kibana/plugins/sql-workbench`.

Ultimately, your directory structure should look like this:

```md
.
├── kibana
│ └── plugins
│ └── sql-kibana-plugin
│ └── sql-workbench
```


## Build

To build the plugin's distributable zip simply run `yarn build`.

Example output: `./build/sql-workbench-*.zip`
Example output: `./build/opendistro-sql-workbench-*.zip`


## Run
Expand All @@ -53,7 +52,7 @@ Example output: `./build/sql-workbench-*.zip`
## Contributing to Open Distro for Elasticsearch SQL Workbench

- Refer to [CONTRIBUTING.md](./CONTRIBUTING.md).
- Since this is a Workbench, it can be useful to review the [Kibana contributing guide](https://github.com/elastic/kibana/blob/master/CONTRIBUTING.md) alongside the documentation around [Workbenchs](https://www.elastic.co/guide/en/kibana/master/kibana-plugins.html) and [plugin development](https://www.elastic.co/guide/en/kibana/master/plugin-development.html).
- Since this is a workbench, it can be useful to review the [Kibana contributing guide](https://github.com/elastic/kibana/blob/master/CONTRIBUTING.md) alongside the documentation around [workbenchs](https://www.elastic.co/guide/en/kibana/master/kibana-plugins.html) and [plugin development](https://www.elastic.co/guide/en/kibana/master/plugin-development.html).

## Bugs, Enhancements or Questions

Expand Down
2 changes: 1 addition & 1 deletion index.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import QueryService from './server/services/QueryService';
import TranslateService from './server/services/TranslateService';
import { createSqlCluster } from './server/clusters';

export const PLUGIN_NAME = 'sql-kibana';
export const PLUGIN_NAME = 'opendistro-sql-workbench';

export default function (kibana) {
return new kibana.Plugin({
Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
{
"name": "sql-kibana",
"name": "opendistro-sql-workbench",
"version": "1.8.0.0",
"description": "SQL Workbench",
"main": "index.js",
"license": "Apache-2.0",
"homepage": "https://github.com/opendistro-for-elasticsearch/sql-kibana-plugin",
"homepage": "https://github.com/opendistro-for-elasticsearch/sql-workbench",
"kibana": {
"version": "7.7.0",
"templateVersion": "6.3.3"
},
"repository": {
"type": "git",
"url": "https://github.com/opendistro-for-elasticsearch/sql-kibana-plugin"
"url": "https://github.com/opendistro-for-elasticsearch/sql-workbench"
},
"scripts": {
"preinstall": "node ../../preinstall_check",
Expand Down
6 changes: 0 additions & 6 deletions release-notes/sql-kibana.release-notes-1.8.0.0.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -2,50 +2,50 @@

### Initial Release

This is the first official release of Open Distro SQL Kibana plugin.
This is the first official release of Open Distro SQL Workbench.

To use the SQL Kibana plugin, you will need the [Open Distro SQL plugin](https://github.com/opendistro-for-elasticsearch/sql). This plugin you will be able to write SQL queries from a console UI directly through Kibana.
To use the SQL Workbench, you will need the [Open Distro SQL plugin](https://github.com/opendistro-for-elasticsearch/sql). This plugin you will be able to write SQL queries from a console UI directly through Kibana.


### Features

- Initialize SQL Kibana plugin ([#1](https://github.com/opendistro-for-elasticsearch/sql-kibana-plugin/pull/1))
- SQL Kibana plugin functionality implementation ([#2](https://github.com/opendistro-for-elasticsearch/sql-kibana-plugin/pull/2))
- Update plugin name and adjust dependency version ([#3](https://github.com/opendistro-for-elasticsearch/sql-kibana-plugin/pull/3))
- Added kibana plugin helper configuration ([#4](https://github.com/opendistro-for-elasticsearch/sql-kibana-plugin/pull/4))
- Adjust the service routes to call SQL plugin ([#5](https://github.com/opendistro-for-elasticsearch/sql-kibana-plugin/pull/5))
- Bumped up the version to support v7.3 compatibility ([#6](https://github.com/opendistro-for-elasticsearch/sql-kibana-plugin/pull/6))
- Updated configureation for v7.3 compatibility ([#7](https://github.com/opendistro-for-elasticsearch/sql-kibana-plugin/pull/7))
- Opendistro-1.3 compatible with ES and Kibana 7.3 ([#8](https://github.com/opendistro-for-elasticsearch/sql-kibana-plugin/pull/8))
- Changed kibana version to v7.3.2 ([#9](https://github.com/opendistro-for-elasticsearch/sql-kibana-plugin/pull/9))
- Initialize SQL Kibana plugin ([#1](https://github.com/opendistro-for-elasticsearch/sql-workbench/pull/1))
- SQL Kibana plugin functionality implementation ([#2](https://github.com/opendistro-for-elasticsearch/sql-workbench/pull/2))
- Update plugin name and adjust dependency version ([#3](https://github.com/opendistro-for-elasticsearch/sql-workbench/pull/3))
- Added kibana plugin helper configuration ([#4](https://github.com/opendistro-for-elasticsearch/sql-workbench/pull/4))
- Adjust the service routes to call SQL plugin ([#5](https://github.com/opendistro-for-elasticsearch/sql-workbench/pull/5))
- Bumped up the version to support v7.3 compatibility ([#6](https://github.com/opendistro-for-elasticsearch/sql-workbench/pull/6))
- Updated configureation for v7.3 compatibility ([#7](https://github.com/opendistro-for-elasticsearch/sql-workbench/pull/7))
- Opendistro-1.3 compatible with ES and Kibana 7.3 ([#8](https://github.com/opendistro-for-elasticsearch/sql-workbench/pull/8))
- Changed kibana version to v7.3.2 ([#9](https://github.com/opendistro-for-elasticsearch/sql-workbench/pull/9))
- Support v7.1.1 Compatibility ([#13](v13))
- Bump pr-branch to v1.3 ([#21](https://github.com/opendistro-for-elasticsearch/sql-kibana-plugin/pull/21))
- Support v7.4 compatibility for kibana and sql-plugin ([#23](https://github.com/opendistro-for-elasticsearch/sql-kibana-plugin/pull/23))
- Improve the performance by ridding of sending redundant requests ([#24](https://github.com/opendistro-for-elasticsearch/sql-kibana-plugin/pull/24))
- Added raw format in download options ([#25](https://github.com/opendistro-for-elasticsearch/sql-kibana-plugin/pull/25))
- Update the release notes for the first official release ([#27](https://github.com/opendistro-for-elasticsearch/sql-kibana-plugin/pull/27))
- Updated test cases and snapshots ([#28](https://github.com/opendistro-for-elasticsearch/sql-kibana-plugin/pull/28))
- Initial merge from development branches to master ([#31](https://github.com/opendistro-for-elasticsearch/sql-kibana-plugin/pull/31))
- Support the result table to display results of DESCRIBE/SHOW/DELETE queries ([#37](https://github.com/opendistro-for-elasticsearch/sql-kibana-plugin/pull/37))
- Adjust the appearance of SQL Workbench UI ([#38](https://github.com/opendistro-for-elasticsearch/sql-kibana-plugin/pull/38))
- Migrated the default request format from Json to JDBC ([#41](https://github.com/opendistro-for-elasticsearch/sql-kibana-plugin/pull/41))
- Support v7.6.1 compatibility ([#42](https://github.com/opendistro-for-elasticsearch/sql-kibana-plugin/pull/42))
- Removed the overriding settings in css ([#44](https://github.com/opendistro-for-elasticsearch/sql-kibana-plugin/pull/44))
- Updated outdated dependencies ([#47](https://github.com/opendistro-for-elasticsearch/sql-kibana-plugin/pull/47))
- Updated open source code compliance ([#48](https://github.com/opendistro-for-elasticsearch/sql-kibana-plugin/pull/48))
- Opendistro Release v1.7.0 ([#56](https://github.com/opendistro-for-elasticsearch/sql-kibana-plugin/pull/56))
- Set up workflows for testing, building artifacts and releasing ([#58](https://github.com/opendistro-for-elasticsearch/sql-kibana-plugin/pull/58))
- Update copyright from year 2019 to 2020 ([#59](https://github.com/opendistro-for-elasticsearch/sql-kibana-plugin/pull/59))
- Moved release notes to dedicated folder ([#60](https://github.com/opendistro-for-elasticsearch/sql-kibana-plugin/pull/60))
- Added contributors file ([#61](https://github.com/opendistro-for-elasticsearch/sql-kibana-plugin/pull/61))
- Updated lastest yarn.lock for accurate dependency alert ([#62](https://github.com/opendistro-for-elasticsearch/sql-kibana-plugin/pull/62))
- Updated snapshot ([#63](https://github.com/opendistro-for-elasticsearch/sql-kibana-plugin/pull/63))
- Bump pr-branch to v1.3 ([#21](https://github.com/opendistro-for-elasticsearch/sql-workbench/pull/21))
- Support v7.4 compatibility for kibana and sql-plugin ([#23](https://github.com/opendistro-for-elasticsearch/sql-workbench/pull/23))
- Improve the performance by ridding of sending redundant requests ([#24](https://github.com/opendistro-for-elasticsearch/sql-workbench/pull/24))
- Added raw format in download options ([#25](https://github.com/opendistro-for-elasticsearch/sql-workbench/pull/25))
- Update the release notes for the first official release ([#27](https://github.com/opendistro-for-elasticsearch/sql-workbench/pull/27))
- Updated test cases and snapshots ([#28](https://github.com/opendistro-for-elasticsearch/sql-workbench/pull/28))
- Initial merge from development branches to master ([#31](https://github.com/opendistro-for-elasticsearch/sql-workbench/pull/31))
- Support the result table to display results of DESCRIBE/SHOW/DELETE queries ([#37](https://github.com/opendistro-for-elasticsearch/sql-workbench/pull/37))
- Adjust the appearance of SQL Workbench UI ([#38](https://github.com/opendistro-for-elasticsearch/sql-workbench/pull/38))
- Migrated the default request format from Json to JDBC ([#41](https://github.com/opendistro-for-elasticsearch/sql-workbench/pull/41))
- Support v7.6.1 compatibility ([#42](https://github.com/opendistro-for-elasticsearch/sql-workbench/pull/42))
- Removed the overriding settings in css ([#44](https://github.com/opendistro-for-elasticsearch/sql-workbench/pull/44))
- Updated outdated dependencies ([#47](https://github.com/opendistro-for-elasticsearch/sql-workbench/pull/47))
- Updated open source code compliance ([#48](https://github.com/opendistro-for-elasticsearch/sql-workbench/pull/48))
- Opendistro Release v1.7.0 ([#56](https://github.com/opendistro-for-elasticsearch/sql-workbench/pull/56))
- Set up workflows for testing, building artifacts and releasing ([#58](https://github.com/opendistro-for-elasticsearch/sql-workbench/pull/58))
- Update copyright from year 2019 to 2020 ([#59](https://github.com/opendistro-for-elasticsearch/sql-workbench/pull/59))
- Moved release notes to dedicated folder ([#60](https://github.com/opendistro-for-elasticsearch/sql-workbench/pull/60))
- Added contributors file ([#61](https://github.com/opendistro-for-elasticsearch/sql-workbench/pull/61))
- Updated lastest yarn.lock for accurate dependency alert ([#62](https://github.com/opendistro-for-elasticsearch/sql-workbench/pull/62))
- Updated snapshot ([#63](https://github.com/opendistro-for-elasticsearch/sql-workbench/pull/63))

### Bug Fixes

- Fixed the issue that response failed to be delivered in the console ([#10](https://github.com/opendistro-for-elasticsearch/sql-kibana-plugin/pull/10))
- Fixed the issue that aggregation result not delivered in the table ([#26](https://github.com/opendistro-for-elasticsearch/sql-kibana-plugin/pull/26))
- Fixed the issue that the table remains delivering the cached results table from the last query ([#30](https://github.com/opendistro-for-elasticsearch/sql-kibana-plugin/pull/30))
- Fixed some dependency issues ([#36](https://github.com/opendistro-for-elasticsearch/sql-kibana-plugin/pull/36))
- Fixed: fatal errors occur when import @elastic/eui modules in docker images ([#43](https://github.com/opendistro-for-elasticsearch/sql-kibana-plugin/pull/43))
- BugFix: Corrected the downloaded .csv/.txt files to proper format ([#50](https://github.com/opendistro-for-elasticsearch/sql-kibana-plugin/pull/50))
- Fixed the issue that response failed to be delivered in the console ([#10](https://github.com/opendistro-for-elasticsearch/sql-workbench/pull/10))
- Fixed the issue that aggregation result not delivered in the table ([#26](https://github.com/opendistro-for-elasticsearch/sql-workbench/pull/26))
- Fixed the issue that the table remains delivering the cached results table from the last query ([#30](https://github.com/opendistro-for-elasticsearch/sql-workbench/pull/30))
- Fixed some dependency issues ([#36](https://github.com/opendistro-for-elasticsearch/sql-workbench/pull/36))
- Fixed: fatal errors occur when import @elastic/eui modules in docker images ([#43](https://github.com/opendistro-for-elasticsearch/sql-workbench/pull/43))
- BugFix: Corrected the downloaded .csv/.txt files to proper format ([#50](https://github.com/opendistro-for-elasticsearch/sql-workbench/pull/50))
12 changes: 12 additions & 0 deletions release-notes/sql-workbench.release-notes-1.8.0.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
## 2020-05-14 Version 1.8.0.0 (Current)

### Features
#### Kibana Compatibility

- Support v7.7.0 compatibility ([#67](https://github.com/opendistro-for-elasticsearch/sql-workbench/pull/67))

#### Version 1.8.0.0 Release

- Update release notes and contributors for v1.8 ([#68](https://github.com/opendistro-for-elasticsearch/sql-workbench/pull/68))
- Update README.md ([#71](https://github.com/opendistro-for-elasticsearch/sql-workbench/pull/71))
- Rename plugin name to sql-workbench ([#72](https://github.com/opendistro-for-elasticsearch/sql-workbench/pull/72))

0 comments on commit fa7ac34

Please sign in to comment.