doc: Add README to Secrets SDK w/ how-to, examples #5336
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node | |
| # For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions | |
| name: Zowe CLI | |
| on: | |
| push: | |
| pull_request: | |
| workflow_dispatch: | |
| inputs: | |
| binary-type: | |
| description: Specify whether to use a `debug` or a `release` version of the binary | |
| default: debug | |
| required: false | |
| test-type: | |
| description: Specify whether to run tests using the `binary` or regular `nodejs` executable | |
| default: binary | |
| required: false | |
| imperative-branch: | |
| description: Specify name of Imperative branch to checkout and build from source | |
| required: false | |
| jobs: | |
| test: | |
| if: (github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository) && !contains(github.event.head_commit.message, '[ci skip]') | |
| runs-on: ${{ matrix.os }} | |
| outputs: | |
| npm-resolutions: ${{ steps.npm-update.outputs.result }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| node-version: [16.x, 18.x] | |
| os: [windows-latest, ubuntu-latest, macos-latest] | |
| env: | |
| OS: ${{ matrix.os }} | |
| NODE: ${{ matrix.node-version }} | |
| NODE_OPTIONS: --max_old_space_size=4096 | |
| timeout-minutes: 60 | |
| concurrency: | |
| group: ${{ matrix.os }}-node-${{ matrix.node-version }}-ci-${{ github.ref }} | |
| cancel-in-progress: true | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| - name: Use Node.js ${{ matrix.node-version }} | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: ${{ matrix.node-version }} | |
| check-latest: true | |
| - name: Disable Lint Annotations | |
| run: | | |
| echo "::remove-matcher owner=eslint-compact::" | |
| echo "::remove-matcher owner=eslint-stylish::" | |
| - name: Get NPM Version | |
| id: npm-version | |
| run: echo "number=$(npm --version)" >> $GITHUB_OUTPUT | |
| - name: Use NPM v8 | |
| id: npm8 | |
| run: npm install -g npm@~8.3.2 | |
| - name: Install Dependencies | |
| run: npm ci | |
| - name: Update Dependencies | |
| id: npm-update | |
| uses: zowe-actions/octorelease/script@v1 | |
| with: | |
| script: npmUpdate | |
| - name: Use Original NPM Version | |
| id: original-npm-version | |
| run: npm install -g npm@${{ steps.npm-version.outputs.number }} | |
| - name: Install Rust toolchain | |
| id: install-rust | |
| if: github.event.inputs.test-type == 'binary' || github.event_name == 'push' | |
| uses: dtolnay/rust-toolchain@stable | |
| - name: Checkout Imperative | |
| id: checkout-imperative | |
| if: github.event_name == 'workflow_dispatch' && github.event.inputs.imperative-branch != '' | |
| run: | | |
| cd node_modules/@zowe && npx rimraf imperative | |
| git clone --branch ${{ github.event.inputs.imperative-branch }} --depth 1 https://github.com/zowe/imperative.git | |
| cd imperative && npm ci --ignore-scripts && npx tsc | |
| - name: Build Source | |
| id: build | |
| run: npm run build | |
| - name: Build Binary | |
| id: build-binary | |
| if: matrix.os != 'windows-latest' && (github.event.inputs.test-type == 'binary' || github.event_name == 'push') | |
| run: | | |
| cargo build --verbose ${{ github.event.inputs.binary-type == 'release' && '--release' || '' }} --manifest-path=zowex/Cargo.toml | |
| tar -cvzf zowe.tgz -C zowex/target/${{ github.event.inputs.binary-type == 'release' && 'release' || 'debug' }} zowe | |
| - name: Build Binary (Windows) | |
| id: build-windows-binary | |
| if: matrix.os == 'windows-latest' && (github.event.inputs.test-type == 'binary' || github.event_name == 'push') | |
| run: | | |
| cargo build --verbose ${{ github.event.inputs.binary-type == 'release' && '--release' || '' }} --manifest-path=zowex/Cargo.toml | |
| tar -cvzf zowe.tgz -C zowex/target/${{ github.event.inputs.binary-type == 'release' && 'release' || 'debug' }} zowe.exe | |
| env: | |
| RUSTFLAGS: "-Ctarget-feature=+crt-static" | |
| - name: Archive Binary | |
| if: github.event.inputs.test-type == 'binary' || github.event_name == 'push' | |
| id: upload-binary | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: zowe-${{ matrix.os }}.tgz | |
| path: zowe.tgz | |
| - name: Setup Binary in PATH | |
| if: github.event.inputs.test-type == 'binary' || github.event_name == 'push' | |
| id: setup-binary | |
| shell: bash | |
| run: | | |
| tar -xvzf zowe.tgz -C ./__tests__/__resources__/daemon_instances | |
| echo "${{ github.workspace }}/__tests__/__resources__/application_instances" >> $GITHUB_PATH | |
| - name: Test Rust EXE and zowe script | |
| id: test-exe-and-script | |
| if: ${{ steps.setup-binary.outcome == 'success' && (github.event.inputs.test-type == 'binary' || github.event_name == 'push') }} | |
| run: cargo test ${{ github.event.inputs.binary-type == 'release' && '--release' || '' }} --manifest-path=zowex/Cargo.toml -- --nocapture | |
| - name: Unit Tests | |
| if: ${{ always() && steps.build.outcome == 'success' }} | |
| run: npm run test:unit | |
| - name: Unlock Keyring | |
| id: unlock-keyring | |
| if: ${{ always() && steps.build.outcome == 'success' && matrix.os == 'ubuntu-latest' }} | |
| uses: t1m0thyj/unlock-keyring@v1 | |
| - name: Start Daemon on Windows only | |
| id: start-daemon | |
| if: ${{ always() && steps.build.outcome == 'success' && matrix.os == 'windows-latest' && (github.event.inputs.test-type == 'binary' || github.event_name == 'push') }} | |
| run: ./__tests__/__resources__/daemon_instances/zowe | |
| - name: Integration Tests (Native) | |
| if: ${{ always() && steps.build.outcome == 'success' && !(github.event.inputs.test-type == 'binary' || github.event_name == 'push') }} | |
| run: npm run test:integration | |
| - name: Integration Tests (Daemon) | |
| if: ${{ always() && steps.build.outcome == 'success' && (github.event.inputs.test-type == 'binary' || github.event_name == 'push') }} | |
| run: npm run test:integration -- --runInBand | |
| - name: Archive Results | |
| if: ${{ always() && steps.build.outcome == 'success' }} | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: ${{ matrix.os }}-${{ matrix.node-version }}-results | |
| path: __tests__/__results__/ | |
| - name: Upload Results to Codecov | |
| if: ${{ always() && steps.build.outcome == 'success' }} | |
| uses: codecov/codecov-action@v3 | |
| with: | |
| env_vars: OS,NODE | |
| release: | |
| if: github.event_name == 'push' && github.ref_protected | |
| needs: test | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 0 | |
| persist-credentials: false | |
| ref: ${{ github.ref }} | |
| # Use Node 16 until npm@9 bundled with Node 18 becomes more stable | |
| - name: Use Node.js 16 | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: '16' | |
| - name: Install Dependencies | |
| run: npm ci | |
| - name: Update Dependencies | |
| uses: zowe-actions/octorelease/script@v1 | |
| env: | |
| GIT_COMMITTER_NAME: ${{ secrets.ZOWE_ROBOT_USER }} | |
| GIT_COMMITTER_EMAIL: ${{ secrets.ZOWE_ROBOT_EMAIL }} | |
| NPM_RESOLUTIONS: ${{ needs.test.outputs.npm-resolutions }} | |
| with: | |
| script: npmUpdate | |
| - name: Build Source | |
| run: npm run build | |
| - uses: zowe-actions/octorelease@v1 | |
| env: | |
| GIT_COMMITTER_NAME: ${{ secrets.ZOWE_ROBOT_USER }} | |
| GIT_COMMITTER_EMAIL: ${{ secrets.ZOWE_ROBOT_EMAIL }} | |
| GIT_CREDENTIALS: x-access-token:${{ secrets.ZOWE_ROBOT_TOKEN }} | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| NPM_USERNAME: ${{ secrets.ARTIFACTORY_USERNAME }} | |
| NPM_PASSWORD: ${{ secrets.ARTIFACTORY_PASSWORD }} | |
| NPM_EMAIL: ${{ secrets.ZOWE_ROBOT_EMAIL }} |