/zowe-install-packaging

Packaging repository for the Zowe install scripts and files

Primary LanguageShellEclipse Public License 2.0EPL-2.0

zowe-install-packaging

This repository includes Zowe installation script and pipelines to build Zowe.

Branches

  • From master branch, you can find the most recent stable build. It matches to the most recent official Zowe release.
  • rc branch means release candidate and is mainly for release usage. It's an intermediate state where we hold the code to prepare for the coming release. This branch is merged from staging and eventually if Release Candidate builds are tested passed, this branch will be merged into master to announce a formal release.
  • staging branch is targeted to the next release and holds the most recent development progress. Normally a development changes may result in a Pull Request against this branch.
  • v?.x/* branches are for past and future purpose. It may also have v?.x/master and v?.x/staging, etc.

Pull Request is required to merge changes to staging, rc. Generally master doesn't accept Pull Request to make feature changes or bug fixes.

Manifest File

Zowe include several components. manifest.json.template defines general information of Zowe and how components are included into official build.

The manifest file include these sections:

General information

These information are represented in these properties: name, version, description, license and homepage.

Build information

These information includes details when building the Zowe artifact. During build process, manifest.json.template will be converted to manifest.json and the template variables like {BUILD_COMMIT_HASH} will be filled in with real value. The modified manifest.json will be placed into root folder of Zowe build.

Here is an example of build information after build, you can find it in the manifest.json file from every Zowe build:

  "build": {
    "branch": "staging",
    "number": "202",
    "commitHash": "dad00f0a9c45f34bfbe3ec56a8443f2e818e59f4",
    "timestamp": "1568205429441"
  },

The above build information means this Zowe build is from staging branch build #202, git commit hash is dad00f0a9c45f34bfbe3ec56a8443f2e818e59f4. Build time is 1568205429441, which means Wed Sep 11 2019 08:37:09 GMT-0400 (Eastern Daylight Time).

Binary Dependencies

binaryDependencies section defines how many components will be included into the binary build. Each component has an unique ID, which hints where the pipeline should pick up the component artifact. Also for each the component, it defines which version will be included into the build.

Here is an example of component definition:

    "org.zowe.explorer.jobs": {
      "version": "~0.2.8-STAGING",
      "explode": "true"
    }

org.zowe.explorer.jobs is the component ID, which also tell the pipeline to pick the component from Artifactory path <repo>/org/zowe/explorer/jobs/. version defines which version we should pick. In this case, we should pick the max version matches 0.2.*-STAGING and >= 0.2.8-STAGING. So version 0.2.10-STAGING is a good match if it exists.

For details of how to define a component, please check examples and explanations from https://zowe.github.io/jenkins-library/jenkins_shared_library/artifact/JFrogArtifactory.html#interpretArtifactDefinition(java.lang.String,%20java.util.Map,%20java.util.Map).

Source Dependencies

sourceDependencies section defines how the component binary matches to the Zowe github repository, branch or tag. It is grouped by componentGroup. For example, Zowe Application Framework componentGroup includes all repositories related it and listed in entries section.

One example component entry looks like:

  {
    "repository": "imperative",
    "tag": "v2.4.9"
  }

This means the Zowe build is using https://github.com/zowe/imperative repository tag v2.4.9.

Please note, this section may not reflect the correct value for non-formal-release. Only for formal releases, we will update these sections to match the correct repository tags.

To check for each release, what source code from repositories will be used, you can:

Point of Contacts

For each Zowe component, we have point of contact(s) in case if we want to confirm the versions defined in the manifest.json.template:

  • API Mediation Layer: Elliot Jalley, Mark Ackert
    • Binary Dependencies
      • org.zowe.apiml.sdk.zowe-install
    • Source Dependencies
      • api-layer
  • zLux, ZSS and Cross Memory Server: James Struga
    • Binary Dependencies
      • org.zowe.zlux.sample-angular-app
      • org.zowe.zlux.sample-iframe-app
      • org.zowe.zlux.sample-react-app
      • org.zowe.zlux.tn3270-ng2
      • org.zowe.zlux.vt-ng2
      • org.zowe.zlux.zlux-core
      • org.zowe.zlux.zlux-editor
      • org.zowe.zss
    • Source Dependencies
      • zlux-app-manager
      • zlux-app-server
      • zlux-file-explorer
      • zlux-grid
      • zlux-platform
      • zlux-server-framework
      • zlux-shared
      • zlux-widgets
      • zlux-build
      • zss
      • zowe-common-c
      • tn3270-ng2
      • sample-angular-app
      • sample-iframe-app
      • sample-react-app
      • vt-ng2
      • zlux-editor
  • Explorer APIs / UI Plugins: Jordan Cain
    • Binary Dependencies
      • org.zowe.explorer.data.sets
      • org.zowe.explorer.jobs
      • org.zowe.explorer-jes
      • org.zowe.explorer-mvs
      • org.zowe.explorer-uss
    • Source Dependencies
      • data-sets
      • jobs
      • explorer-api-common
      • explorer-jes
      • explorer-mvs
      • explorer-uss
      • orion-editor-component
      • explorer-ui-server
  • CLI: Fernando Rijo Cedeno, Mark Ackert
    • Source Dependencies
      • imperative
      • zowe-cli
      • zowe-cli-cics-plugin
      • zowe-cli-db2-plugin
      • perf-timing
      • zowe-cli-mq-plugin
      • zowe-cli-scs-plugin
      • zowe-cli-ftp-plugin
      • zowe-cli-ims-plugin
  • Explorer (Visual Studio Code Extension): Fernando Rijo Cedeno, Mark Ackert
    • Source Dependencies
      • zowe-explorer-vscode
  • License: Mark Ackert
    • Binary Dependencies
      • org.zowe.licenses

Build Pipeline

Zowe build pipeline has hooked into github repository. Every branch, commit and PR has potential to kick off a new Zowe build. If the build is not automatically started, you can go to Jenkins and start a build job on the appropriated branch or pull request.

Generate Customized Zowe Build

If your changes are in zowe-install-packaging, you may already have a Zowe build if you have a branch. Otherwise you will have one if you create a pull request on your changes.

If your changes are in components, it may depend on how the Zowe build picks your changes:

  • If you have released, or have a snapshot build of your component, very likely the change will be picked up by the staging branch build. If not, you need to check the binaryDependencies section in manifest.json.template.

  • If your changes is still in a branch of the component repository, you can edit manifest.json.template to use the branch build directly like this:

      "org.zowe.explorer.jobs": {
    "artifact": "lib-snapshot-local/org/zowe/explorer/jobs/0.2.7-MY-BRANCH-BUILD.zip",
    "explode": "true"
  },

Automate Install / Uninstall of Zowe with Ansible

Please check details in playbooks folder.

Quick Sanity Check on Your Zowe Instance

Please check details in sanity test folder.