Skip to content

Commit

Permalink
Fix spelling of npm
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelsauter committed May 31, 2022
1 parent db83b0a commit 1c79cf6
Show file tree
Hide file tree
Showing 8 changed files with 17 additions and 17 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ metadata:
"helm.sh/resource-policy": keep
spec:
description: |
Builds Node.js applications using NPM.
Builds Node.js applications using npm.
The following steps are executed:
Expand All @@ -21,7 +21,7 @@ spec:
for example `npx eslint src --format compact`, together with a config file
(`eslintrc.json` or similar) at the root of the working directory. This can
be done by running `eslint --init` or by following the
ink:https://eslint.org/docs/user-guide/getting-started[official documentation]
link:https://eslint.org/docs/user-guide/getting-started[official documentation]
The exact build recipe can be found at
link:https://github.com/opendevstack/ods-pipeline/blob/master/build/package/scripts/build-npm.sh[build/package/scripts/build-npm.sh].
Expand Down
4 changes: 2 additions & 2 deletions docs/architecture/component-namespaced-installation.puml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Container_Boundary(c1, "Namespaced ODS Pipeline Installation"){

Boundary(tasks, "Tasks") {
Component(task_build_go, "ods-build-go", "Task", "Builds Go (module) applications")
Component(task_build_npm, "ods-build-npm", "Task", "Builds Node.js based applications using NPM")
Component(task_build_npm, "ods-build-npm", "Task", "Builds Node.js based applications using npm")
Component(task_build_python, "ods-build-python", "Task", "Builds Python applications")
Component(task_build_gradle, "ods-build-gradle", "Task", "Builds JDK based applications using Gradle")
Component(task_package_image, "ods-package-image", "Task", "Packages container images")
Expand All @@ -28,7 +28,7 @@ Container_Boundary(c1, "Namespaced ODS Pipeline Installation"){

Boundary(images, "Images") {
Component(image_go_toolset, "ods/go-toolset", "Container Image", "Go, golangci-lint, build script")
Component(image_node16_npm_toolset, "ods/node16-npm-toolset", "Container Image", "Node.js, NPM, build script")
Component(image_node16_npm_toolset, "ods/node16-npm-toolset", "Container Image", "Node.js, npm, build script")
Component(image_python_toolset, "ods/python-toolset", "Container Image", "Python, build script")
Component(image_gradle_toolset, "ods/gradle-toolset", "Container Image", "JDK, Gradle, build script")
Component(image_buildah, "ods/buildah", "Container Image", "Buildah, Aqua scanner")
Expand Down
2 changes: 1 addition & 1 deletion docs/design/software-architecture.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ image::http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubuse
| Download dependencies
| HTTP
| Nexus
| Nexus serves as a proxy for third party dependencies (e.g. hosted on NPM), and serves private dependencies hosted in Nexus as well.
| Nexus serves as a proxy for third party dependencies (e.g. hosted on npm), and serves private dependencies hosted in Nexus as well.

| Task `ods-package-image`
| Scan for vulnerabilities
Expand Down
6 changes: 3 additions & 3 deletions docs/design/software-design-specification.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,7 @@ Supplies default SonarQube project properties file if required (SDS-SHARED-3).
| `ods-build-npm` Task resource
a| The task defines two steps:

. Build Node.js applications using NPM (referencing SDS-TASK-17 and executing SDS-TASK-18).
. Build Node.js applications using npm (referencing SDS-TASK-17 and executing SDS-TASK-18).
This step supports build skipping (executing SDS-SHARED-5 and/or SDS-SHARED-4 if enabled with parameter `cache-build`)
. Analyze source code (referencing SDS-SHARED-1 and executing SDS-SHARED-2)

Expand All @@ -317,7 +317,7 @@ Input parameters:

| SDS-TASK-17
| `ods-node16-npm-toolset` container image
| Container image to build Node.js applications using NPM. Based on `ubi8/nodejs-16` (SDS-EXT-26), includes SDS-SHARED-3, SDS-TASK-18 and SDS-TASK-28.
| Container image to build Node.js applications using npm. Based on `ubi8/nodejs-16` (SDS-EXT-26), includes SDS-SHARED-3, SDS-TASK-18 and SDS-TASK-28.

| SDS-TASK-18
| `build-npm.sh` shell script
Expand All @@ -337,7 +337,7 @@ Supplies default SonarQube project properties file if required (SDS-SHARED-3).

| SDS-TASK-28
| `npm.properties` properties file
| Default configuration for NPM SonarQube project.
| Default configuration for npm SonarQube project.
|===

==== `ods-package-image` task
Expand Down
6 changes: 3 additions & 3 deletions docs/design/software-requirements-specification.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -224,15 +224,15 @@ a| The task shall build a Python application.
[cols="1,3"]
|===
| SRS-TASK-BUILD-NPM-1
| The task shall run the NPM lint script.
| The task shall run the npm lint script.

| SRS-TASK-BUILD-NPM-2
a| The task shall run the NPM test script, creating code coverage and xUnit reports.
a| The task shall run the npm test script, creating code coverage and xUnit reports.

* Artifacts shall be made available to SonarQube and designated for upload to Nexus.

| SRS-TASK-BUILD-NPM-3
a| The task shall build a Node.JS application using NPM.
a| The task shall build a Node.JS application using npm.

* Destination directory shall be customizable

Expand Down
6 changes: 3 additions & 3 deletions docs/design/stakeholder-requirements.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -62,12 +62,12 @@ Stakeholder requirements describe what the tool shall be able to accomplish and


| SHR-4
| ODS Pipeline shall provide a task supporting to build Node.JS applications using NPM:
| ODS Pipeline shall provide a task supporting to build Node.JS applications using npm:

- lint JavaScript/TypeScript source code files
- statically analyse JavaScript/TypeScript source code files
- run the NPM test script
- run the NPM build task
- run the npm test script
- run the npm build task


| SHR-5
Expand Down
2 changes: 1 addition & 1 deletion docs/introduction.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ An ODS pipeline installation provides you with the following tasks, which are im
* `ods-start`: Checkout repository and set Bitbucket build status
* `ods-build-go`: Build a Go application (includes Sonar scan)
* `ods-build-gradle`: Build a JDK based application using Gradle (includes Sonar scan)
* `ods-build-npm`: Build a Node.js based application using NPM (includes Sonar scan)
* `ods-build-npm`: Build a Node.js based application using npm (includes Sonar scan)
* `ods-build-python`: Build a Python application (includes Sonar scan)
* `ods-package-image`: Package application into container image (includes optional Aqua scan)
* `ods-deploy-helm`: Deploy a Helm chart
Expand Down
4 changes: 2 additions & 2 deletions docs/tasks/ods-build-npm.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

= ods-build-npm

Builds Node.js applications using NPM.
Builds Node.js applications using npm.

The following steps are executed:

Expand All @@ -16,7 +16,7 @@ For linting to work there needs to be a `lint` task in the `package.json` file,
for example `npx eslint src --format compact`, together with a config file
(`eslintrc.json` or similar) at the root of the working directory. This can
be done by running `eslint --init` or by following the
ink:https://eslint.org/docs/user-guide/getting-started[official documentation]
link:https://eslint.org/docs/user-guide/getting-started[official documentation]

The exact build recipe can be found at
link:https://github.com/opendevstack/ods-pipeline/blob/master/build/package/scripts/build-npm.sh[build/package/scripts/build-npm.sh].
Expand Down

0 comments on commit 1c79cf6

Please sign in to comment.