From 994c7b96e66221f298fdb727f21af2e8ae151c16 Mon Sep 17 00:00:00 2001 From: Joshua Li Date: Wed, 31 Jan 2024 16:00:38 -0800 Subject: [PATCH] Move gantt-chart out from subdirectory (#321) (#325) Signed-off-by: Joshua Li (cherry picked from commit 12ad9b729ad3290c84a7cb5c681aca94f7102efe) (cherry picked from commit af334cac6c842f1bffbb64ecd53b1f10f105440f) --- gantt-chart/.babelrc => .babelrc | 0 .../fixtures/jaeger-sample.txt | 0 .../integration/ui.spec.js | 0 .../.cypress => .cypress}/plugins/index.js | 0 .../.cypress => .cypress}/support/commands.js | 0 .../support/constants.js | 0 .../.cypress => .cypress}/support/index.js | 0 .../.cypress => .cypress}/tsconfig.json | 0 .../.cypress => .cypress}/utils/constants.js | 0 gantt-chart/.eslintrc.yaml => .eslintrc.yaml | 0 .github/workflows/test-and-build-workflow.yml | 53 +++++++++---------- gantt-chart/.gitignore => .gitignore | 0 ....opensearch_dashboards-plugin-helpers.json | 0 DEVELOPER_GUIDE.md | 10 ++-- gantt-chart/cypress.json => cypress.json | 0 ...hboards.json => opensearch_dashboards.json | 0 gantt-chart/package.json => package.json | 0 .../__tests__/gantt_vis_type.test.ts | 0 .../__snapshots__/gantt_chart.test.tsx.snap | 0 .../gantt_chart_editor.test.tsx.snap | 0 .../options_editor.test.tsx.snap | 0 .../components/__tests__/gantt_chart.test.tsx | 0 .../__tests__/gantt_chart_editor.test.tsx | 0 .../__tests__/options_editor.test.tsx | 0 .../components/gantt_chart.tsx | 0 .../components/gantt_chart_editor.tsx | 0 .../components/options_editor.tsx | 0 .../gantt_request_handler.ts | 0 .../public => public}/gantt_vis_type.ts | 0 {gantt-chart/public => public}/index.scss | 0 {gantt-chart/public => public}/index.ts | 0 {gantt-chart/public => public}/plugin.ts | 0 {gantt-chart/server => server}/index.ts | 0 {gantt-chart/server => server}/plugin.ts | 0 .../server => server}/routes/index.ts | 0 {gantt-chart/server => server}/types.ts | 0 {gantt-chart/test => test}/jest.config.js | 0 {gantt-chart/test => test}/mocks/fileMock.ts | 0 .../test => test}/mocks/httpClientMock.ts | 0 {gantt-chart/test => test}/mocks/mockData.ts | 0 .../test => test}/mocks/routerPropsMock.ts | 0 {gantt-chart/test => test}/mocks/styleMock.ts | 0 {gantt-chart/test => test}/setup.jest.ts | 0 {gantt-chart/test => test}/setupTests.ts | 0 gantt-chart/tsconfig.json => tsconfig.json | 0 gantt-chart/yarn.lock => yarn.lock | 0 46 files changed, 28 insertions(+), 35 deletions(-) rename gantt-chart/.babelrc => .babelrc (100%) rename gantt-chart/.cypress/utils/jaeger-sample.json => .cypress/fixtures/jaeger-sample.txt (100%) rename {gantt-chart/.cypress => .cypress}/integration/ui.spec.js (100%) rename {gantt-chart/.cypress => .cypress}/plugins/index.js (100%) rename {gantt-chart/.cypress => .cypress}/support/commands.js (100%) rename {gantt-chart/.cypress => .cypress}/support/constants.js (100%) rename {gantt-chart/.cypress => .cypress}/support/index.js (100%) rename {gantt-chart/.cypress => .cypress}/tsconfig.json (100%) rename {gantt-chart/.cypress => .cypress}/utils/constants.js (100%) rename gantt-chart/.eslintrc.yaml => .eslintrc.yaml (100%) rename gantt-chart/.gitignore => .gitignore (100%) rename gantt-chart/.opensearch_dashboards-plugin-helpers.json => .opensearch_dashboards-plugin-helpers.json (100%) rename gantt-chart/cypress.json => cypress.json (100%) rename gantt-chart/opensearch_dashboards.json => opensearch_dashboards.json (100%) rename gantt-chart/package.json => package.json (100%) rename {gantt-chart/public => public}/__tests__/gantt_vis_type.test.ts (100%) rename {gantt-chart/public => public}/components/__tests__/__snapshots__/gantt_chart.test.tsx.snap (100%) rename {gantt-chart/public => public}/components/__tests__/__snapshots__/gantt_chart_editor.test.tsx.snap (100%) rename {gantt-chart/public => public}/components/__tests__/__snapshots__/options_editor.test.tsx.snap (100%) rename {gantt-chart/public => public}/components/__tests__/gantt_chart.test.tsx (100%) rename {gantt-chart/public => public}/components/__tests__/gantt_chart_editor.test.tsx (100%) rename {gantt-chart/public => public}/components/__tests__/options_editor.test.tsx (100%) rename {gantt-chart/public => public}/components/gantt_chart.tsx (100%) rename {gantt-chart/public => public}/components/gantt_chart_editor.tsx (100%) rename {gantt-chart/public => public}/components/options_editor.tsx (100%) rename {gantt-chart/public => public}/gantt_request_handler.ts (100%) rename {gantt-chart/public => public}/gantt_vis_type.ts (100%) rename {gantt-chart/public => public}/index.scss (100%) rename {gantt-chart/public => public}/index.ts (100%) rename {gantt-chart/public => public}/plugin.ts (100%) rename {gantt-chart/server => server}/index.ts (100%) rename {gantt-chart/server => server}/plugin.ts (100%) rename {gantt-chart/server => server}/routes/index.ts (100%) rename {gantt-chart/server => server}/types.ts (100%) rename {gantt-chart/test => test}/jest.config.js (100%) rename {gantt-chart/test => test}/mocks/fileMock.ts (100%) rename {gantt-chart/test => test}/mocks/httpClientMock.ts (100%) rename {gantt-chart/test => test}/mocks/mockData.ts (100%) rename {gantt-chart/test => test}/mocks/routerPropsMock.ts (100%) rename {gantt-chart/test => test}/mocks/styleMock.ts (100%) rename {gantt-chart/test => test}/setup.jest.ts (100%) rename {gantt-chart/test => test}/setupTests.ts (100%) rename gantt-chart/tsconfig.json => tsconfig.json (100%) rename gantt-chart/yarn.lock => yarn.lock (100%) diff --git a/gantt-chart/.babelrc b/.babelrc similarity index 100% rename from gantt-chart/.babelrc rename to .babelrc diff --git a/gantt-chart/.cypress/utils/jaeger-sample.json b/.cypress/fixtures/jaeger-sample.txt similarity index 100% rename from gantt-chart/.cypress/utils/jaeger-sample.json rename to .cypress/fixtures/jaeger-sample.txt diff --git a/gantt-chart/.cypress/integration/ui.spec.js b/.cypress/integration/ui.spec.js similarity index 100% rename from gantt-chart/.cypress/integration/ui.spec.js rename to .cypress/integration/ui.spec.js diff --git a/gantt-chart/.cypress/plugins/index.js b/.cypress/plugins/index.js similarity index 100% rename from gantt-chart/.cypress/plugins/index.js rename to .cypress/plugins/index.js diff --git a/gantt-chart/.cypress/support/commands.js b/.cypress/support/commands.js similarity index 100% rename from gantt-chart/.cypress/support/commands.js rename to .cypress/support/commands.js diff --git a/gantt-chart/.cypress/support/constants.js b/.cypress/support/constants.js similarity index 100% rename from gantt-chart/.cypress/support/constants.js rename to .cypress/support/constants.js diff --git a/gantt-chart/.cypress/support/index.js b/.cypress/support/index.js similarity index 100% rename from gantt-chart/.cypress/support/index.js rename to .cypress/support/index.js diff --git a/gantt-chart/.cypress/tsconfig.json b/.cypress/tsconfig.json similarity index 100% rename from gantt-chart/.cypress/tsconfig.json rename to .cypress/tsconfig.json diff --git a/gantt-chart/.cypress/utils/constants.js b/.cypress/utils/constants.js similarity index 100% rename from gantt-chart/.cypress/utils/constants.js rename to .cypress/utils/constants.js diff --git a/gantt-chart/.eslintrc.yaml b/.eslintrc.yaml similarity index 100% rename from gantt-chart/.eslintrc.yaml rename to .eslintrc.yaml diff --git a/.github/workflows/test-and-build-workflow.yml b/.github/workflows/test-and-build-workflow.yml index 964c158..0434889 100644 --- a/.github/workflows/test-and-build-workflow.yml +++ b/.github/workflows/test-and-build-workflow.yml @@ -15,21 +15,23 @@ jobs: runs-on: ubuntu-latest steps: - - name: Checkout Plugin - uses: actions/checkout@v2 - - name: Checkout OpenSearch Dashboards uses: actions/checkout@v2 with: repository: opensearch-project/Opensearch-Dashboards ref: ${{ env.OPENSEARCH_VERSION }} - path: dashboards-visualizations/OpenSearch-Dashboards + path: OpenSearch-Dashboards + + - name: Checkout Plugin + uses: actions/checkout@v2 + with: + path: OpenSearch-Dashboards/plugins/dashboards-visualizations - name: Get node and yarn versions id: versions_step run: | - echo "::set-output name=node_version::$(node -p "(require('./dashboards-visualizations/OpenSearch-Dashboards/package.json').engines.node).match(/[.0-9]+/)[0]")" - echo "::set-output name=yarn_version::$(node -p "(require('./dashboards-visualizations/OpenSearch-Dashboards/package.json').engines.yarn).match(/[.0-9]+/)[0]")" + echo "::set-output name=node_version::$(node -p "(require('./OpenSearch-Dashboards/package.json').engines.node).match(/[.0-9]+/)[0]")" + echo "::set-output name=yarn_version::$(node -p "(require('./OpenSearch-Dashboards/package.json').engines.yarn).match(/[.0-9]+/)[0]")" - name: Setup node uses: actions/setup-node@v1 @@ -43,29 +45,25 @@ jobs: echo "Installing yarn ${{ steps.versions_step.outputs.yarn_version }}" npm i -g yarn@${{ steps.versions_step.outputs.yarn_version }} - - name: Move Gantt Chart to Plugins Dir - run: | - mv gantt-chart ./dashboards-visualizations/OpenSearch-Dashboards/plugins - - name: Plugin Bootstrap run: | - cd ./dashboards-visualizations/OpenSearch-Dashboards/plugins/gantt-chart + cd ./OpenSearch-Dashboards/plugins/dashboards-visualizations yarn osd bootstrap - name: Test run: | - cd ./dashboards-visualizations/OpenSearch-Dashboards/plugins/gantt-chart + cd ./OpenSearch-Dashboards/plugins/dashboards-visualizations yarn test --coverage - name: Upload coverage uses: codecov/codecov-action@v1 with: - directory: ./dashboards-visualizations/OpenSearch-Dashboards/plugins/gantt-chart + directory: ./OpenSearch-Dashboards/plugins/dashboards-visualizations token: ${{ secrets.CODECOV_TOKEN }} - name: Build Artifact run: | - cd ./dashboards-visualizations/OpenSearch-Dashboards/plugins/gantt-chart + cd ./OpenSearch-Dashboards/plugins/dashboards-visualizations yarn build mv ./build/*.zip ./build/${{ env.PLUGIN_NAME }}-${{ env.OPENSEARCH_PLUGIN_VERSION }}.zip @@ -73,14 +71,12 @@ jobs: uses: actions/upload-artifact@v1 with: name: gantt-chart-ubuntu - path: ./dashboards-visualizations/OpenSearch-Dashboards/plugins/gantt-chart/build + path: ./OpenSearch-Dashboards/plugins/dashboards-visualizations/build windows-build: runs-on: windows-latest steps: - - name: Checkout Plugin - uses: actions/checkout@v2 # Enable longer filenames for windows - name: Enable longer filenames run: git config --system core.longpaths true @@ -90,13 +86,18 @@ jobs: with: repository: opensearch-project/Opensearch-Dashboards ref: ${{ env.OPENSEARCH_VERSION }} - path: dashboards-visualizations/OpenSearch-Dashboards + path: OpenSearch-Dashboards + + - name: Checkout Plugin + uses: actions/checkout@v2 + with: + path: OpenSearch-Dashboards/plugins/dashboards-visualizations - name: Get node and yarn versions id: versions_step run: | - echo "::set-output name=node_version::$(node -p "(require('./dashboards-visualizations/OpenSearch-Dashboards/package.json').engines.node).match(/[.0-9]+/)[0]")" - echo "::set-output name=yarn_version::$(node -p "(require('./dashboards-visualizations/OpenSearch-Dashboards/package.json').engines.yarn).match(/[.0-9]+/)[0]")" + echo "::set-output name=node_version::$(node -p "(require('./OpenSearch-Dashboards/package.json').engines.node).match(/[.0-9]+/)[0]")" + echo "::set-output name=yarn_version::$(node -p "(require('./OpenSearch-Dashboards/package.json').engines.yarn).match(/[.0-9]+/)[0]")" - name: Setup node uses: actions/setup-node@v1 @@ -110,23 +111,19 @@ jobs: echo "Installing yarn ${{ steps.versions_step.outputs.yarn_version }}" npm i -g yarn@${{ steps.versions_step.outputs.yarn_version }} - - name: Move Gantt Chart to Plugins Dir - run: | - mv gantt-chart ./dashboards-visualizations/OpenSearch-Dashboards/plugins - - name: Plugin Bootstrap run: | - cd ./dashboards-visualizations/OpenSearch-Dashboards/plugins/gantt-chart + cd ./OpenSearch-Dashboards/plugins/dashboards-visualizations yarn osd bootstrap - name: Test run: | - cd ./dashboards-visualizations/OpenSearch-Dashboards/plugins/gantt-chart + cd ./OpenSearch-Dashboards/plugins/dashboards-visualizations yarn test - name: Build Artifact run: | - cd ./dashboards-visualizations/OpenSearch-Dashboards/plugins/gantt-chart + cd ./OpenSearch-Dashboards/plugins/dashboards-visualizations yarn build mv ./build/*.zip ./build/${{ env.PLUGIN_NAME }}-${{ env.OPENSEARCH_PLUGIN_VERSION }}.zip @@ -134,4 +131,4 @@ jobs: uses: actions/upload-artifact@v1 with: name: gantt-chart-windows - path: ./dashboards-visualizations/OpenSearch-Dashboards/plugins/gantt-chart/build + path: ./OpenSearch-Dashboards/plugins/dashboards-visualizations/build diff --git a/gantt-chart/.gitignore b/.gitignore similarity index 100% rename from gantt-chart/.gitignore rename to .gitignore diff --git a/gantt-chart/.opensearch_dashboards-plugin-helpers.json b/.opensearch_dashboards-plugin-helpers.json similarity index 100% rename from gantt-chart/.opensearch_dashboards-plugin-helpers.json rename to .opensearch_dashboards-plugin-helpers.json diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md index 3ebf0ad..fc31cb3 100644 --- a/DEVELOPER_GUIDE.md +++ b/DEVELOPER_GUIDE.md @@ -11,12 +11,8 @@ So you want to contribute code to this project? Excellent! We're glad you're her 1. cd into the OpenSearch Dashboards source code directory. 1. Check out this package from version control into the `plugins` directory. ``` -rm plugins -r -git clone git@github.com:opensearch-project/dashboards-visualizations.git plugins --no-checkout cd plugins -echo 'gantt-chart/*' >> .git/info/sparse-checkout -git config core.sparseCheckout true -git checkout main +git clone git@github.com:opensearch-project/dashboards-visualizations.git ``` 6. Run `yarn osd bootstrap` inside `OpenSearch-Dashboards` directory. @@ -26,7 +22,7 @@ Ultimately, your directory structure should look like this: . ├── OpenSearch Dashboards │ └── plugins -│ └── gantt-chart +│ └── dashboards-visualizations ``` @@ -57,4 +53,4 @@ The Github workflow in [`backport.yml`](.github/workflows/backport.yml) creates with an appropriate label `backport ` is merged to main with the backport workflow run successfully on the PR. For example, if a PR on main needs to be backported to `1.x` branch, add a label `backport 1.x` to the PR and make sure the backport workflow runs on the PR along with other checks. Once this PR is merged to main, the workflow will create a backport PR -to the `1.x` branch. \ No newline at end of file +to the `1.x` branch. diff --git a/gantt-chart/cypress.json b/cypress.json similarity index 100% rename from gantt-chart/cypress.json rename to cypress.json diff --git a/gantt-chart/opensearch_dashboards.json b/opensearch_dashboards.json similarity index 100% rename from gantt-chart/opensearch_dashboards.json rename to opensearch_dashboards.json diff --git a/gantt-chart/package.json b/package.json similarity index 100% rename from gantt-chart/package.json rename to package.json diff --git a/gantt-chart/public/__tests__/gantt_vis_type.test.ts b/public/__tests__/gantt_vis_type.test.ts similarity index 100% rename from gantt-chart/public/__tests__/gantt_vis_type.test.ts rename to public/__tests__/gantt_vis_type.test.ts diff --git a/gantt-chart/public/components/__tests__/__snapshots__/gantt_chart.test.tsx.snap b/public/components/__tests__/__snapshots__/gantt_chart.test.tsx.snap similarity index 100% rename from gantt-chart/public/components/__tests__/__snapshots__/gantt_chart.test.tsx.snap rename to public/components/__tests__/__snapshots__/gantt_chart.test.tsx.snap diff --git a/gantt-chart/public/components/__tests__/__snapshots__/gantt_chart_editor.test.tsx.snap b/public/components/__tests__/__snapshots__/gantt_chart_editor.test.tsx.snap similarity index 100% rename from gantt-chart/public/components/__tests__/__snapshots__/gantt_chart_editor.test.tsx.snap rename to public/components/__tests__/__snapshots__/gantt_chart_editor.test.tsx.snap diff --git a/gantt-chart/public/components/__tests__/__snapshots__/options_editor.test.tsx.snap b/public/components/__tests__/__snapshots__/options_editor.test.tsx.snap similarity index 100% rename from gantt-chart/public/components/__tests__/__snapshots__/options_editor.test.tsx.snap rename to public/components/__tests__/__snapshots__/options_editor.test.tsx.snap diff --git a/gantt-chart/public/components/__tests__/gantt_chart.test.tsx b/public/components/__tests__/gantt_chart.test.tsx similarity index 100% rename from gantt-chart/public/components/__tests__/gantt_chart.test.tsx rename to public/components/__tests__/gantt_chart.test.tsx diff --git a/gantt-chart/public/components/__tests__/gantt_chart_editor.test.tsx b/public/components/__tests__/gantt_chart_editor.test.tsx similarity index 100% rename from gantt-chart/public/components/__tests__/gantt_chart_editor.test.tsx rename to public/components/__tests__/gantt_chart_editor.test.tsx diff --git a/gantt-chart/public/components/__tests__/options_editor.test.tsx b/public/components/__tests__/options_editor.test.tsx similarity index 100% rename from gantt-chart/public/components/__tests__/options_editor.test.tsx rename to public/components/__tests__/options_editor.test.tsx diff --git a/gantt-chart/public/components/gantt_chart.tsx b/public/components/gantt_chart.tsx similarity index 100% rename from gantt-chart/public/components/gantt_chart.tsx rename to public/components/gantt_chart.tsx diff --git a/gantt-chart/public/components/gantt_chart_editor.tsx b/public/components/gantt_chart_editor.tsx similarity index 100% rename from gantt-chart/public/components/gantt_chart_editor.tsx rename to public/components/gantt_chart_editor.tsx diff --git a/gantt-chart/public/components/options_editor.tsx b/public/components/options_editor.tsx similarity index 100% rename from gantt-chart/public/components/options_editor.tsx rename to public/components/options_editor.tsx diff --git a/gantt-chart/public/gantt_request_handler.ts b/public/gantt_request_handler.ts similarity index 100% rename from gantt-chart/public/gantt_request_handler.ts rename to public/gantt_request_handler.ts diff --git a/gantt-chart/public/gantt_vis_type.ts b/public/gantt_vis_type.ts similarity index 100% rename from gantt-chart/public/gantt_vis_type.ts rename to public/gantt_vis_type.ts diff --git a/gantt-chart/public/index.scss b/public/index.scss similarity index 100% rename from gantt-chart/public/index.scss rename to public/index.scss diff --git a/gantt-chart/public/index.ts b/public/index.ts similarity index 100% rename from gantt-chart/public/index.ts rename to public/index.ts diff --git a/gantt-chart/public/plugin.ts b/public/plugin.ts similarity index 100% rename from gantt-chart/public/plugin.ts rename to public/plugin.ts diff --git a/gantt-chart/server/index.ts b/server/index.ts similarity index 100% rename from gantt-chart/server/index.ts rename to server/index.ts diff --git a/gantt-chart/server/plugin.ts b/server/plugin.ts similarity index 100% rename from gantt-chart/server/plugin.ts rename to server/plugin.ts diff --git a/gantt-chart/server/routes/index.ts b/server/routes/index.ts similarity index 100% rename from gantt-chart/server/routes/index.ts rename to server/routes/index.ts diff --git a/gantt-chart/server/types.ts b/server/types.ts similarity index 100% rename from gantt-chart/server/types.ts rename to server/types.ts diff --git a/gantt-chart/test/jest.config.js b/test/jest.config.js similarity index 100% rename from gantt-chart/test/jest.config.js rename to test/jest.config.js diff --git a/gantt-chart/test/mocks/fileMock.ts b/test/mocks/fileMock.ts similarity index 100% rename from gantt-chart/test/mocks/fileMock.ts rename to test/mocks/fileMock.ts diff --git a/gantt-chart/test/mocks/httpClientMock.ts b/test/mocks/httpClientMock.ts similarity index 100% rename from gantt-chart/test/mocks/httpClientMock.ts rename to test/mocks/httpClientMock.ts diff --git a/gantt-chart/test/mocks/mockData.ts b/test/mocks/mockData.ts similarity index 100% rename from gantt-chart/test/mocks/mockData.ts rename to test/mocks/mockData.ts diff --git a/gantt-chart/test/mocks/routerPropsMock.ts b/test/mocks/routerPropsMock.ts similarity index 100% rename from gantt-chart/test/mocks/routerPropsMock.ts rename to test/mocks/routerPropsMock.ts diff --git a/gantt-chart/test/mocks/styleMock.ts b/test/mocks/styleMock.ts similarity index 100% rename from gantt-chart/test/mocks/styleMock.ts rename to test/mocks/styleMock.ts diff --git a/gantt-chart/test/setup.jest.ts b/test/setup.jest.ts similarity index 100% rename from gantt-chart/test/setup.jest.ts rename to test/setup.jest.ts diff --git a/gantt-chart/test/setupTests.ts b/test/setupTests.ts similarity index 100% rename from gantt-chart/test/setupTests.ts rename to test/setupTests.ts diff --git a/gantt-chart/tsconfig.json b/tsconfig.json similarity index 100% rename from gantt-chart/tsconfig.json rename to tsconfig.json diff --git a/gantt-chart/yarn.lock b/yarn.lock similarity index 100% rename from gantt-chart/yarn.lock rename to yarn.lock