Propose namespaced tasks

CHANGELOG.md

@@ -21,6 +21,7 @@ listed in the changelog.
 - Git LFS support enabled ([#420](https://github.com/opendevstack/ods-pipeline/issues/420))
 - Publish images to public registry (ghcr.io) ([#440](https://github.com/opendevstack/ods-pipeline/issues/440))
 - Allow to cache dependencies ([#147](https://github.com/opendevstack/ods-pipeline/issues/147)). See also proposal on caching ([#412](https://github.com/opendevstack/ods-pipeline/pull/412))
+- Support node production builds in docker context ([#357](https://github.com/opendevstack/ods-pipeline/issues/357))
 
 ### Changed
 

Makefile

@@ -134,15 +134,7 @@ start-local-env: ## Restart stopped local environment.
 
 ##@ OpenShift
 
-install-ods-central: ## OpenShift only! Apply ODS BuildConfig, ImageStream and Task manifests
-ifeq ($(strip $(namespace)),)
-	@echo "Argument 'namespace' is required, e.g. make install-ods-central namespace=ods"
-	@exit 1
-endif
-	cd scripts && ./install-ods-central-resources.sh -n $(namespace)
-.PHONY: install-ods-central
-
-start-ods-central-builds: ## OpenShift only! Start builds for each ODS BuildConfig
+start-ods-builds: ## OpenShift only! Start builds for each ODS BuildConfig
 	oc start-build ods-buildah
 	oc start-build ods-finish
 	oc start-build ods-go-toolset
@@ -153,9 +145,9 @@ start-ods-central-builds: ## OpenShift only! Start builds for each ODS BuildConf
 	oc start-build ods-start
 	oc start-build ods-node16-typescript-toolset
 	oc start-build ods-pipeline-manager
-.PHONY: start-ods-central-builds
+.PHONY: start-ods-builds
 
-##@ User Installation
+##@ Installation
 
 install-cd-namespace: ## Install resources in CD namespace via Helm.
 ifeq ($(strip $(namespace)),)

README.md

@@ -14,19 +14,8 @@ ODS Pipeline is well suited for regulated development (e.g. medical device softw
 
 ## Documentation
 
-The documentation provided by ODS pipeline has three audiences:
-
-* **Admins** install and maintain a central ODS pipeline installation in an OpenShift cluster that can be used by many users.
-
-* **Users** consume an existing central ODS pipeline installation. Users install ODS pipeline resources into a namespace they own to run CI/CD pipelines for their repositories.
-
-* **Contributors** work on the ODS pipeline project itself, for example by improving existing tasks, adding new ones, updating documentation, etc.
-
-**Admin Guide**
-* [Installation & Updating](/docs/admin-installation.adoc)
-
 **User Guide**
-* [Installation & Updating](/docs/user-installation.adoc)
+* [Installation & Updating](/docs/installation.adoc)
 * [Getting Started](/docs/getting-started.adoc)
 * [ODS.YAML Reference](/docs/ods-configuration.adoc)
 * [Task Reference](/docs/tasks)

build/package/scripts/build-typescript.sh

@@ -19,6 +19,10 @@ copyLintReport() {
   cp eslint-report.txt "${ROOT_DIR}/.ods/artifacts/lint-reports/${ARTIFACT_PREFIX}report.txt"
 }
 
+# the copy commands are based on GNU cp tools
+# On a mac `brew install coreutils` gives `g` prefixed cmd line tools such as gcp
+# to use these define env variable GNU_CP=gcp before invoking this script.
+CP="${GNU_CP:-cp}"  
 BUILD_DIR="dist"
 OUTPUT_DIR="docker"
 WORKING_DIR="."
@@ -78,6 +82,16 @@ if [ -n "${NEXUS_HOST}" ] && [ -n "${NEXUS_USERNAME}" ] && [ -n "${NEXUS_PASSWOR
     npm config set strict-ssl=false
 fi;
 
+echo "package-*.json checks ..."
+if [ ! -f package.json ]; then
+  echo "File package.json not found"
+  exit 1
+fi 
+if [ ! -f package-lock.json ]; then
+  echo "File package-lock.json not found"
+  exit 1
+fi 
+
 echo "Installing dependencies ..."
 npm ci --ignore-scripts
 
@@ -97,12 +111,19 @@ fi
 
 echo "Building ..."
 npm run build
+# Copying most build output before testing so
+# that additional modules which may be installed by testing 
+# is not included.
+# However copying package.json too early can confuse the tests.
 mkdir -p "${OUTPUT_DIR}"
-cp -r "${BUILD_DIR}" "${OUTPUT_DIR}/dist"
+echo "Copying contents of ${BUILD_DIR} into ${OUTPUT_DIR}/dist ..."
+# see https://unix.stackexchange.com/questions/228597/how-to-copy-a-folder-recursively-in-an-idempotent-way-using-cp
+"$CP" -r "${BUILD_DIR}/." "${OUTPUT_DIR}/dist" 
 
 if [ "${COPY_NODE_MODULES}" = true ]; then
   echo "Copying node_modules to ${OUTPUT_DIR}/dist/node_modules ..."
-  cp -r node_modules "${OUTPUT_DIR}/dist/node_modules"
+  # note "${OUTPUT_DIR}/dist" exists now and node_modules name will be maintained. 
+  "$CP"  -r node_modules "${OUTPUT_DIR}/dist"
 fi
 
 echo "Testing ..."
@@ -131,4 +152,17 @@ else
   cp build/coverage/lcov.info "${ROOT_DIR}/.ods/artifacts/code-coverage/${ARTIFACT_PREFIX}lcov.info"
 fi
 
+# Doing this earlier can confuse jest.
+# test build_typescript_app_with_custom_build_directory fails with
+#  jest-haste-map: Haste module naming collision: src
+#    The following files share their name; please adjust your hasteImpl:
+#      * <rootDir>/package.json
+#      * <rootDir>/docker/package.json
+#  No tests found, exiting with code 1
+# While one could demand to change the config of the test, there is no need
+# to copy this earlier
+echo "Copying package.json and package-lock.json to ${OUTPUT_DIR}/dist ..."
+cp package.json package-lock.json "${OUTPUT_DIR}/dist"
+
+
 supply-sonar-project-properties-default

deploy/ods-pipeline/charts/tasks/templates/task-ods-build-typescript.yaml

@@ -8,6 +8,7 @@ spec:
 
     The following steps are executed:
 
+    - checks that package.json and package-lock.json exists to require best practice of using lock files. See also link:https://github.com/opendevstack/ods-pipeline/discussions/411[discussion 411]
     - linting using `eslint`
     - build typescript application, using `npm run build`
     - test execution
@@ -82,13 +83,15 @@ spec:
     - name: build-dir
       description: >-
         Must match the directory into which `npm run build` places files.
-        The files inside `build-dir` will be copied to `output-dir`.
+        The files inside `build-dir` will be copied to the `dist` folder in `output-dir`
+        As a result the files will be in `$output-dir/dist`
         Other common build directories are `build` and `public`.
       type: string
       default: "dist"
     - name: copy-node-modules
       description: >-
         Whether `node-modules` is copied to the `output-dir` or not.
+        If copied the node modules are in `$output-dir/dist/node_modules`. 
         For frontend components this should be set to "false",
         while for backend components this should be set to "true".
       type: string