Merge pull request #1770 from zowe/v2-release

Prepare 2.0.0 Release
zowe · Apr 27, 2022 · 18aa81c · 18aa81c
2 parents dbaf2fb + 1d65d11
commit 18aa81c
Show file tree

Hide file tree

Showing 133 changed files with 9,829 additions and 7,620 deletions.
diff --git a/.github/workflows/deployment.yml b/.github/workflows/deployment.yml
@@ -4,14 +4,14 @@ on:
  push:
  branches:
  - master
- - next
+ - v1-lts
  paths:
  - package.json
  workflow_dispatch:
  inputs:
  version:
  description: Version to be published
- default: v1.22.1
+ default: v2.0.0
  required: false
  # create_release:
  # description: Create the release even if publishing already happened

diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -0,0 +1,25 @@
+name: Lint
+
+on: [push, pull_request]
+
+jobs:
+ lint:
+ runs-on: ubuntu-latest
+
+ if: (github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository) && !contains(github.event.head_commit.message, '[ci skip]')
+
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v2
+
+ - name: Use Node.js LTS
+ uses: actions/setup-node@v2
+ with:
+ node-version: lts/*
+
+ - run: |
+ npm install -g yarn
+ yarn install --frozen-lockfile
+
+ - name: Lint
+ run: yarn lint
diff --git a/.github/workflows/theia-zowe-explorer-ci.yml b/.github/workflows/theia-zowe-explorer-ci.yml
@@ -5,14 +5,24 @@ on:
  push:
  paths:
  - packages/zowe-explorer/**
+ - packages/zowe-explorer-api/**
  pull_request:
  paths:
  - packages/zowe-explorer/**
+ - packages/zowe-explorer-api/**
 
 jobs:
  ze-theia-build:
  runs-on: ubuntu-latest
 
+ timeout-minutes: 60
+
+ concurrency:
+ group: ubuntu-latest-theia-ci-${{ github.ref }}
+ cancel-in-progress: true
+
+ if: (github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository) && !contains(github.event.head_commit.message, '[ci skip]')
+
  steps:
  # check out source
  - uses: actions/checkout@v2
@@ -50,7 +60,8 @@ jobs:
  # # --health-cmd "curl --fail http://localhost:3000 || exit 1" --health-interval=5s --health-timeout=5s --health-retries 60
  # options: --init
 
- - run: yarn lint
+ - name: Allow some time for the theia server to load
+ run: sleep 30s
 
  - name: Verify plugin loaded
  run: docker exec -i theia ls -la /home/theia/plugins

diff --git a/.github/workflows/zowe-explorer-ci.yml b/.github/workflows/zowe-explorer-ci.yml
@@ -4,22 +4,32 @@ on:
  push:
  paths:
  - packages/zowe-explorer/**
+ - packages/zowe-explorer-api/**
  pull_request:
  paths:
  - packages/zowe-explorer/**
+ - packages/zowe-explorer-api/**
 
 jobs:
  ze-build:
  runs-on: ${{ matrix.os }}
 
+ timeout-minutes: 60
+
+ concurrency:
+ group: ${{ matrix.os }}-node-${{ matrix.node-version }}-ze-ci-${{ github.ref }}
+ cancel-in-progress: true
+
  strategy:
  # Continue to run tests on the other systems if one fails
  fail-fast: false
  matrix:
- node-version: [12.x, 14.x]
+ node-version: [14, 16]
  # order operating systems from best to worst
  os: [windows-latest, ubuntu-latest, macos-latest]
 
+ if: (github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository) && !contains(github.event.head_commit.message, '[ci skip]')
+
  steps:
  - name: Check out code
  uses: actions/checkout@v2

diff --git a/.github/workflows/zowe-explorer-ftp-ci.yml b/.github/workflows/zowe-explorer-ftp-ci.yml
@@ -4,22 +4,32 @@ on:
  push:
  paths:
  - packages/zowe-explorer-ftp-extension/**
+ - packages/zowe-explorer-api/**
  pull_request:
  paths:
  - packages/zowe-explorer-ftp-extension/**
+ - packages/zowe-explorer-api/**
 
 jobs:
  zftp-build:
  runs-on: ${{ matrix.os }}
 
+ timeout-minutes: 60
+
+ concurrency:
+ group: ${{ matrix.os }}-node-${{ matrix.node-version }}-ze-ftp-ci-${{ github.ref }}
+ cancel-in-progress: true
+
  strategy:
  # Continue to run tests on the other systems if one fails
  fail-fast: false
  matrix:
- node-version: [12.x, 14.x]
+ node-version: [14, 16]
  # order operating systems from best to worst
  os: [windows-latest, ubuntu-latest, macos-latest]
 
+ if: (github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository) && !contains(github.event.head_commit.message, '[ci skip]')
+
  steps:
  - name: Check out code
  uses: actions/checkout@v2

diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -13,6 +13,16 @@
  "args": ["--extensionDevelopmentPath=${workspaceFolder}/packages/zowe-explorer", "--verbose"],
  "outFiles": ["${workspaceFolder}/packages/zowe-explorer/out/**/*.js"],
  "preLaunchTask": "build dev watch",
+ "smartStep": true,
+ "skipFiles": ["<node_internals>/**"]
+ },
+ {
+ "name": "Run Zowe Explorer VS Code Extension (Theia)",
+ "type": "extensionHost",
+ "request": "launch",
+ "runtimeExecutable": "${execPath}",
+ "args": ["--extensionDevelopmentPath=${workspaceFolder}/packages/zowe-explorer", "--verbose"],
+ "outFiles": ["${workspaceFolder}/packages/zowe-explorer/out/**/*.js"],
  "smartStep": true
  },
  {
@@ -32,7 +42,8 @@
  "args": ["--extensionDevelopmentPath=${workspaceFolder}/packages/zowe-explorer-ftp-extension", "--verbose"],
  "outFiles": ["${workspaceFolder}/packages/zowe-explorer-ftp-extension/out/**/*.js"],
  "preLaunchTask": "build dev watch ftp",
- "smartStep": true
+ "smartStep": true,
+ "skipFiles": ["<node_internals>/**"]
  },
  {
  "type": "node",
@@ -42,7 +53,9 @@
  "args": ["--runInBand"],
  "cwd": "${workspaceFolder}/packages/zowe-explorer",
  "console": "integratedTerminal",
- "internalConsoleOptions": "neverOpen"
+ "internalConsoleOptions": "neverOpen",
+ "smartStep": true,
+ "skipFiles": ["<node_internals>/**"]
  },
  {
  "name": "Zowe Explorer Integration Tests (Mocha)",

diff --git a/docs/Conformance Criteria/README-Conformance Criteria V2.md b/docs/Conformance Criteria/README-Conformance Criteria V2.md
@@ -169,7 +169,7 @@ Criteria for VS Code extensions that want to access the same Zowe CLI profiles t
  <th style="background-color:#AAAAAA">x</th>
  <th style="background-color:#AAAAAA"></th>
  <th></th>
- <td><b>VS Code extension dependency:</b> Extension declares Zowe Explorer as a VS Code extension dependency by including an `extensionDependencies` entry for Zowe Explorer in its package.json file.</td>
+ <td><b>VS Code extension dependency:</b> If the extension calls the Zowe Explorer API it must declare Zowe Explorer as a VS Code extension dependency by including an <b>extensionDependencies</b> entry for Zowe Explorer in its package.json file. <em>This ensures Zowe Explorer and Zowe Explorer API are activated and initialized for proper use by its extenders</em></td>
  </tr>
 
  <tr>
@@ -215,15 +215,6 @@ Criteria for VS Code extensions that want to access the same Zowe CLI profiles t
  <th></th>
  <td><b>v1 Profile Support:</b> Extension has a backwards compatibility and it is able to support v1 type of profiles.</td>
  </tr>
-
- <tr>
- <th style="background-color:#555555">17</th>
- <th style="background-color:#555555">v2</th>
- <th style="background-color:#AAAAAA">x</th>
- <th style="background-color:#AAAAAA"></th>
- <th></th>
- <td><b>Secure Credential Store:</b> Extension calls the <a href=https://github.com/zowe/vscode-extension-for-zowe/blob/master/docs/extenders/SecureCredentials.md>Zowe Explorer-provided method</a> for initialization of secure credentials at startup.</td>
- </tr>
 </table>
 
 ### Data Provider Extension
@@ -241,6 +232,15 @@ Criteria for VS Code extensions that extend the Zowe Explorer MVS, USS, or JES t
  </thead>
 
  <tr>
+ <th style="background-color:#555555">17</th>
+ <th style="background-color:#555555">v2</th>
+ <th style="background-color:#AAAAAA">x</th>
+ <th style="background-color:#AAAAAA"></th>
+ <th></th>
+ <td><b>VS Code extension dependency:</b> If the extension calls the Zowe Explorer API it must declare Zowe Explorer as a VS Code extension dependency by including an <b>extensionDependencies</b> entry for Zowe Explorer in its package.json file. <em>This ensures Zowe Explorer and Zowe Explorer API are activated and initialized for proper use by its extenders</td>
+</tr>
+
+<tr>
  <th style="background-color:#555555">18</th>
  <th style="background-color:#555555">v2</th>
  <th style="background-color:#AAAAAA">x</th>
@@ -294,14 +294,23 @@ Criteria for VS Code extensions adding menu and commands to VS Code that utilize
  <tr>
  <th style="background-color:#555555">22</th>
  <th style="background-color:#555555">v2</th>
+ <th style="background-color:#AAAAAA"></th>
+ <th style="background-color:#AAAAAA">x</th>
+ <th></th>
+ <td><b>VS Code extension dependency:</b> If the extension calls the Zowe Explorer API it should declare Zowe Explorer as a VS Code extension dependency by including an <b>extensionDependencies</b> entry for Zowe Explorer in its package.json file. <em>This ensures Zowe Explorer and Zowe Explorer API are activated and initialized for proper use by its extenders</em></td>
+ </tr>
+
+ <tr>
+ <th style="background-color:#555555">23</th>
+ <th style="background-color:#555555">v2</th>
  <th style="background-color:#AAAAAA">x</th>
  <th style="background-color:#AAAAAA"></th>
  <th></th>
  <td><b>Command operations: </b> If the extension is adding new commands to Zowe Explorer's tree views, the commands must not replace any existing Zowe Explorer commands.</td>
  </tr>
 
  <tr>
- <th style="background-color:#555555">23</th>
+ <th style="background-color:#555555">24</th>
  <th style="background-color:#555555">v2</th>
  <th style="background-color:#AAAAAA"></th>
  <th style="background-color:#AAAAAA">x</th>
@@ -310,7 +319,7 @@ Criteria for VS Code extensions adding menu and commands to VS Code that utilize
  </tr>
 
  <tr>
- <th style="background-color:#555555">24</th>
+ <th style="background-color:#555555">25</th>
  <th style="background-color:#555555">v2</th>
  <th style="background-color:#AAAAAA">x</th>
  <th style="background-color:#AAAAAA"></th>
@@ -319,7 +328,7 @@ Criteria for VS Code extensions adding menu and commands to VS Code that utilize
  </tr>
 
  <tr>
- <th style="background-color:#555555">25</th>
+ <th style="background-color:#555555">26</th>
  <th style="background-color:#555555">v2</th>
  <th style="background-color:#AAAAAA">x</th>
  <th style="background-color:#AAAAAA"></th>
@@ -328,7 +337,7 @@ Criteria for VS Code extensions adding menu and commands to VS Code that utilize
  </tr>
 
  <tr>
- <th style="background-color:#555555">26</th>
+ <th style="background-color:#555555">27</th>
  <th style="background-color:#555555">v2</th>
  <th style="background-color:#AAAAAA"></th>
  <th style="background-color:#AAAAAA">x</th>
@@ -338,7 +347,7 @@ Criteria for VS Code extensions adding menu and commands to VS Code that utilize
  </tr>
 
  <tr>
- <th style="background-color:#555555">27</th>
+ <th style="background-color:#555555">28</th>
  <th style="background-color:#555555">v2</th>
  <th style="background-color:#AAAAAA">x</th>
  <th style="background-color:#AAAAAA"></th>
@@ -348,7 +357,7 @@ Criteria for VS Code extensions adding menu and commands to VS Code that utilize
  </tr>
 
  <tr>
- <th style="background-color:#555555">28</th>
+ <th style="background-color:#555555">29</th>
  <th style="background-color:#555555">v2</th>
  <th style="background-color:#AAAAAA">x</th>
  <th style="background-color:#AAAAAA"></th>

diff --git a/docs/Early Access - Changes Affecting Extenders.md b/docs/Early Access - Changes Affecting Extenders.md
@@ -0,0 +1,53 @@
+# Version 1 to Version 2 Changes Affecting Zowe Explorer Extenders
+
+In the move from Zowe Explorer version 1 to version 2, several changes were implemented to make Zowe Explorer more consistent and follow best practices and standards. Some of these changes affect how Zowe Explorer extenders interact with Zowe Explorer and its API. These are listed below with guidance for how extenders can update their Zowe Explorer extensions to continue working with Zowe Explorer version 2.
+
+## Zowe Explorer View IDs
+
+Zowe Explorer's view IDs have been updated to improve the consistency of the formatting. The following chart shows the updated view IDs:
+
+| View | Version 1 View ID | Version 2 View ID |
+| -------------- | ------------------- | -------------------- |
+| Data Sets view | `zowe.explorer` | `zowe.ds.explorer` |
+| USS view | `zowe.uss.explorer` | `zowe.uss.explorer` |
+| Jobs view | `zowe.jobs` | `zowe.jobs.explorer` |
+
+## Migration of old settings to new standardized settings in Zowe Explorer
+
+### Overview of new standardized name settings
+
+The following table describes the changes from old to new standardized names for Zowe Explorer configurations. These changes were made to conform to VS Code's [configuration schema](https://code.visualstudio.com/api/references/contribution-points#Configuration-schema):
+
+| Version 1 Setting Name | Version 2 Setting Name |
+| ------------------------------- | ------------------------------------------ |
+| `Zowe-Default-Datasets-Binary` | `zowe.ds.default.binary` |
+| `Zowe-Default-Datasets-C` | `zowe.ds.default.c` |
+| `Zowe-Default-Datasets-Classic` | `zowe.ds.default.classic` |
+| `Zowe-Default-Datasets-PDS` | `zowe.ds.default.pds` |
+| `Zowe-Default-Datasets-PS` | `zowe.ds.default.ps` |
+| `Zowe-Temp-Folder-Location` | `zowe.files.temporaryDownloadsFolder.path` |
+| `Zowe Security: Credential Key` | `zowe.security.credentialPlugin` |
+| `Zowe Commands: History` | `zowe.commands.history` |
+| `Zowe Commands: Always Edit` | `zowe.commands.alwaysEdit` |
+| `Zowe-Automatic-Validation` | `zowe.automaticProfileValidation` |
+| `Zowe-DS-Persistent` | `zowe.ds.history` |
+| `Zowe-USS-Persistent` | `zowe.uss.history` |
+| `Zowe-Jobs-Persistent` | `zowe.jobs.history` |
+
+### Feature Overview
+
+- Migration of old Zowe settings is performed upon activation of the extension automatically and is run only once since the migration has no need to be performed multiple times.
+
+- A change of scope for all history based settings have been made as well, these settings have been changed from the **window** scope to the **application** scope. The affected settings would be the following:
+ - `zowe.ds.history` (Zowe-DS-Persistent)
+ - `zowe.uss.history` (Zowe-USS-Persistent)
+ - `zowe.jobs.history` (Zowe-Jobs-Persistent)
+ - `zowe.commands.history` (Zowe Commands: History)
+
+### What Will Happen To My Old Setting Configurations?
+
+- The old settings will be migrated to the new settings as long as they are present in their old configuration names and were not under the default settings whether they were stored under the user, workspace, or both settings in VS Code.
+
+### What To Do With My Old Settings?
+
+- Upon loading up VS Code Zowe Explorer will performed an automated migration of the old user settings to the new standardized settings. After this is completed, the older settings will appear greyed out meaning they can be manually removed since they will no longer be of use.