Skip to content

zowe/zlux-build

Repository files navigation

This program and the accompanying materials are made available under the terms of the Eclipse Public License v2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-v20.html

SPDX-License-Identifier: EPL-2.0

Copyright Contributors to the Zowe Project.

zlux-build

This repository includes build scripts used for building Zowe App Framework code, and build pipeline used for building Zowe App Framework with multiple pull request.

Build Scripts

To request features or report bugs, please use the issues page at the zlux repo with the CI/CD tag

These scripts require at least version 1.9.1 of Apache Ant. ant-contrib is also required.

Use 'ant help' to get list of targets accessible from this directory

The script has two primary parts: deploy and build. Deploy populates the deploy directory under zlux-app-server. Build will build the source of the file so it can be used within the brower

The default behavior for a plugin is to navigate to its home directory, as defined by the directory given in its pluginDefinition.json file, and then run npm install and npm run build. This can be altered by adding a build/build.xml file to the plugin's home directory. Having a deploy target in this file will cause it to be run during the deploy step. This is useful for adding plugin-specific configuration files. If there is a build target in this file, it will be run instead of npm install and npm run build. You can still call those functions within the build target, but you can use ant to do whatever other build steps need to be done

The build requires a plugin directory which is defined in common.properties. This directory lists all the plugins that will be deployed and built.

There is an optional value to pass to the build task: 'noInstall' noInstall does not run 'npm install', only 'npm run build'. If node modules are already installed, this will cut down the install time in about half.

This flag is set in the following manner: -D [flag]=[value] The script logic only looks for the two option flags to be set, the value does not matter.

Build Pipeline

To build zlux-core with multiple pull request edit the Jenkinsfile to point to the pull request you want to build with. There should be a map call zluxParameters with keys and values, just add the pull request number to the value of the key you want. If the value is empty it will default to v2.x/staging.

Copyright

This program and the accompanying materials are made available under the terms of the Eclipse Public License v2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-v20.html

SPDX-License-Identifier: EPL-2.0

Copyright Contributors to the Zowe Project.