From b0aba31dc83afc71cd46200fdebee9e8c61ec2bf Mon Sep 17 00:00:00 2001 From: Alexandre Alves Date: Thu, 28 Nov 2024 16:05:05 +0000 Subject: [PATCH] Small fixes for docs and extensions workflow tests (#12704) * small fix extensions workflow tests + update docs for extensions * small fix extensions workflow tests * fix annotation in migration script --- .../workflows/test-extension-workflows-release-2.8.yml | 8 ++++---- .../workflows/test-extension-workflows-release-2.9.yml | 8 ++++---- creators/extension/migrate/tasks/packageUpdates.js | 2 +- docusaurus/docs/extensions/extensions-getting-started.md | 2 +- docusaurus/docs/extensions/rancher-2.10-support.md | 4 ++-- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/.github/workflows/test-extension-workflows-release-2.8.yml b/.github/workflows/test-extension-workflows-release-2.8.yml index e3ab3e6ec6..2e875c8b83 100644 --- a/.github/workflows/test-extension-workflows-release-2.8.yml +++ b/.github/workflows/test-extension-workflows-release-2.8.yml @@ -41,8 +41,8 @@ jobs: target_branch: 'gh-pages' tagged_release: ${{ needs.retrieve-tags-release-2-dot-8.outputs.EXTENSIONS_TAG }} is_test: 'true' - test_ext_repo: 'ui-plugin-examples' - test_ext_branch: 'main' + test_ext_repo: 'elemental-ui' + test_ext_branch: 'release-2.8.x' test-build-extension-catalog-release-2-dot-8: needs: retrieve-tags-release-2-dot-8 uses: rancher/dashboard/.github/workflows/build-extension-catalog.yml@release-2.8 @@ -55,8 +55,8 @@ jobs: registry_user: ${{ github.actor }} tagged_release: ${{ needs.retrieve-tags-release-2-dot-8.outputs.ECI_TAG }} is_test: 'true' - test_ext_repo: 'ui-plugin-examples' - test_ext_branch: 'main' + test_ext_repo: 'elemental-ui' + test_ext_branch: 'release-2.8.x' secrets: registry_token: ${{ secrets.GITHUB_TOKEN }} test-release-shell-pkg-release-2-dot-8: diff --git a/.github/workflows/test-extension-workflows-release-2.9.yml b/.github/workflows/test-extension-workflows-release-2.9.yml index 64361595a4..dadc9563c6 100644 --- a/.github/workflows/test-extension-workflows-release-2.9.yml +++ b/.github/workflows/test-extension-workflows-release-2.9.yml @@ -41,8 +41,8 @@ jobs: target_branch: 'gh-pages' tagged_release: ${{ needs.retrieve-tags-release-2-dot-9.outputs.EXTENSIONS_TAG }} is_test: 'true' - test_ext_repo: 'ui-plugin-examples' - test_ext_branch: 'main' + test_ext_repo: 'elemental-ui' + test_ext_branch: 'release-2.9.x' test-build-extension-catalog-release-2-dot-9: needs: retrieve-tags-release-2-dot-9 uses: rancher/dashboard/.github/workflows/build-extension-catalog.yml@release-2.9 @@ -55,8 +55,8 @@ jobs: registry_user: ${{ github.actor }} tagged_release: ${{ needs.retrieve-tags-release-2-dot-9.outputs.ECI_TAG }} is_test: 'true' - test_ext_repo: 'ui-plugin-examples' - test_ext_branch: 'main' + test_ext_repo: 'elemental-ui' + test_ext_branch: 'release-2.9.x' secrets: registry_token: ${{ secrets.GITHUB_TOKEN }} test-release-shell-pkg-release-2-dot-9: diff --git a/creators/extension/migrate/tasks/packageUpdates.js b/creators/extension/migrate/tasks/packageUpdates.js index 47e3a0fe17..20481b3673 100644 --- a/creators/extension/migrate/tasks/packageUpdates.js +++ b/creators/extension/migrate/tasks/packageUpdates.js @@ -214,7 +214,7 @@ function packageUpdatesAnnotations(file, oldContent) { // The file is in pkg//package.json const annotations = { 'catalog.cattle.io/rancher-version': '>= 2.10.0-0', - 'catalog.cattle.io/ui-extensions-version': '>= 3.0.0', + 'catalog.cattle.io/ui-extensions-version': '>= 3.0.0 < 4.0.0', }; if (!parsedJson.rancher) { diff --git a/docusaurus/docs/extensions/extensions-getting-started.md b/docusaurus/docs/extensions/extensions-getting-started.md index 0362374c75..9ddf6ed010 100644 --- a/docusaurus/docs/extensions/extensions-getting-started.md +++ b/docusaurus/docs/extensions/extensions-getting-started.md @@ -6,7 +6,7 @@ This guide will walk through creating a new extension from scratch. > Note: Extensions development is only currently supported on Mac and Linux. Windows is not currently supported. -You will need a recent version of nodejs installed (Tested with node version: `v16.19.1`). +You will need a recent version of nodejs installed. We recommend node version `20.17.0`. You'll also need the yarn package manager installed, which can be done with `npm install -g yarn`. diff --git a/docusaurus/docs/extensions/rancher-2.10-support.md b/docusaurus/docs/extensions/rancher-2.10-support.md index b222b2e5f4..9cd151d9be 100644 --- a/docusaurus/docs/extensions/rancher-2.10-support.md +++ b/docusaurus/docs/extensions/rancher-2.10-support.md @@ -50,7 +50,7 @@ These are the most common Vue3 syntax changes that you may encounter on your ext ## New mandatory annotation -One of the new changes that we've introduced is that for a published extension to be loaded into a Rancher `2.10` system, the published helm chart for a particular version **must** include the `catalog.cattle.io/ui-extensions-version` annotation, being the minimum version needed `>= 3.0.0`. +One of the new changes that we've introduced is that for a published extension to be loaded into a Rancher `2.10` system, the published helm chart for a particular version **must** include the `catalog.cattle.io/ui-extensions-version` annotation, being the minimum version needed `>= 3.0.0`. We also recommend to set a maximum of `< 4.0.0` on this new annotation. We also recommend that you update the `catalog.cattle.io/rancher-version` to `>= 2.10.0`. @@ -64,7 +64,7 @@ You should check that your extension `pkg/<-YOUR EXTENSION->/package.json` shows "rancher": { "annotations": { "catalog.cattle.io/rancher-version": ">= 2.10.0", - "catalog.cattle.io/ui-extensions-version": ">= 3.0.0" + "catalog.cattle.io/ui-extensions-version": ">= 3.0.0 < 4.0.0" } }, ....