Skip to content
This repository was archived by the owner on Mar 21, 2025. It is now read-only.

Commit 1c79cf6

Browse files
author
Michael Sauter
committed
Fix spelling of npm
1 parent db83b0a commit 1c79cf6

8 files changed

+17
-17
lines changed

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ metadata:
77
"helm.sh/resource-policy": keep
88
spec:
99
description: |
10-
Builds Node.js applications using NPM.
10+
Builds Node.js applications using npm.
1111
1212
The following steps are executed:
1313
@@ -21,7 +21,7 @@ spec:
2121
for example `npx eslint src --format compact`, together with a config file
2222
(`eslintrc.json` or similar) at the root of the working directory. This can
2323
be done by running `eslint --init` or by following the
24-
ink:https://eslint.org/docs/user-guide/getting-started[official documentation]
24+
link:https://eslint.org/docs/user-guide/getting-started[official documentation]
2525
2626
The exact build recipe can be found at
2727
link:https://github.com/opendevstack/ods-pipeline/blob/master/build/package/scripts/build-npm.sh[build/package/scripts/build-npm.sh].

docs/architecture/component-namespaced-installation.puml

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Container_Boundary(c1, "Namespaced ODS Pipeline Installation"){
1717

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

2929
Boundary(images, "Images") {
3030
Component(image_go_toolset, "ods/go-toolset", "Container Image", "Go, golangci-lint, build script")
31-
Component(image_node16_npm_toolset, "ods/node16-npm-toolset", "Container Image", "Node.js, NPM, build script")
31+
Component(image_node16_npm_toolset, "ods/node16-npm-toolset", "Container Image", "Node.js, npm, build script")
3232
Component(image_python_toolset, "ods/python-toolset", "Container Image", "Python, build script")
3333
Component(image_gradle_toolset, "ods/gradle-toolset", "Container Image", "JDK, Gradle, build script")
3434
Component(image_buildah, "ods/buildah", "Container Image", "Buildah, Aqua scanner")

docs/design/software-architecture.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ image::http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubuse
7777
| Download dependencies
7878
| HTTP
7979
| Nexus
80-
| Nexus serves as a proxy for third party dependencies (e.g. hosted on NPM), and serves private dependencies hosted in Nexus as well.
80+
| Nexus serves as a proxy for third party dependencies (e.g. hosted on npm), and serves private dependencies hosted in Nexus as well.
8181

8282
| Task `ods-package-image`
8383
| Scan for vulnerabilities

docs/design/software-design-specification.adoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -299,7 +299,7 @@ Supplies default SonarQube project properties file if required (SDS-SHARED-3).
299299
| `ods-build-npm` Task resource
300300
a| The task defines two steps:
301301

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

@@ -317,7 +317,7 @@ Input parameters:
317317

318318
| SDS-TASK-17
319319
| `ods-node16-npm-toolset` container image
320-
| 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.
320+
| 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.
321321

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

338338
| SDS-TASK-28
339339
| `npm.properties` properties file
340-
| Default configuration for NPM SonarQube project.
340+
| Default configuration for npm SonarQube project.
341341
|===
342342

343343
==== `ods-package-image` task

docs/design/software-requirements-specification.adoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -224,15 +224,15 @@ a| The task shall build a Python application.
224224
[cols="1,3"]
225225
|===
226226
| SRS-TASK-BUILD-NPM-1
227-
| The task shall run the NPM lint script.
227+
| The task shall run the npm lint script.
228228

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

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

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

237237
* Destination directory shall be customizable
238238

docs/design/stakeholder-requirements.adoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -62,12 +62,12 @@ Stakeholder requirements describe what the tool shall be able to accomplish and
6262

6363

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

6767
- lint JavaScript/TypeScript source code files
6868
- statically analyse JavaScript/TypeScript source code files
69-
- run the NPM test script
70-
- run the NPM build task
69+
- run the npm test script
70+
- run the npm build task
7171

7272

7373
| SHR-5

docs/introduction.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ An ODS pipeline installation provides you with the following tasks, which are im
3636
* `ods-start`: Checkout repository and set Bitbucket build status
3737
* `ods-build-go`: Build a Go application (includes Sonar scan)
3838
* `ods-build-gradle`: Build a JDK based application using Gradle (includes Sonar scan)
39-
* `ods-build-npm`: Build a Node.js based application using NPM (includes Sonar scan)
39+
* `ods-build-npm`: Build a Node.js based application using npm (includes Sonar scan)
4040
* `ods-build-python`: Build a Python application (includes Sonar scan)
4141
* `ods-package-image`: Package application into container image (includes optional Aqua scan)
4242
* `ods-deploy-helm`: Deploy a Helm chart

docs/tasks/ods-build-npm.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
= ods-build-npm
44

5-
Builds Node.js applications using NPM.
5+
Builds Node.js applications using npm.
66

77
The following steps are executed:
88

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

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

0 commit comments

Comments
 (0)