Skip to content

Commit

Permalink
update documentation, readme and metadata files
Browse files Browse the repository at this point in the history
  • Loading branch information
BraisVQ committed Dec 4, 2023
1 parent 7d358a7 commit 6dc72de
Show file tree
Hide file tree
Showing 8 changed files with 36 additions and 18 deletions.
17 changes: 17 additions & 0 deletions docs/modules/jenkins-agents/pages/nodejs20.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
= Node.js 20 - Jenkins agent

== Introduction
This agent is used to build Node.js-based projects, through `npm` or `yarn`.

The image is built in the global `ods` project and is named `jenkins-agent-nodejs20`.
It can be referenced in a `Jenkinsfile` with `ods/jenkins-agent-nodejs20`.

IMPORTANT: Node.js version 20 reaches end-of-life in 2026-04-30. Support for this version will be removed in releases after this date. Please consider switching to newer versions of this agent as soon as they are available.

== Features
1. Nexus configuration
2. HTTP proxy awareness
3. Yarn & Cypress dependencies pre-installed

== Known limitations
n/a
1 change: 1 addition & 0 deletions docs/modules/quickstarters/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
*** xref:jenkins-agents:nodejs12.adoc[Node.js 12]
*** xref:jenkins-agents:nodejs16.adoc[Node.js 16]
*** xref:jenkins-agents:nodejs18.adoc[Node.js 18]
*** xref:jenkins-agents:nodejs20.adoc[Node.js 20]
*** xref:jenkins-agents:python.adoc[Python]
*** xref:jenkins-agents:scala.adoc[Scala]
** xref:quickstarters:authoring-quickstarters.adoc[Authoring Quickstarters]
14 changes: 7 additions & 7 deletions docs/modules/quickstarters/pages/be-typescript-express.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

== Purpose of this quickstarter (use this when you want to ...)

This is a https://nodejs.org/en/[Node.js] (v18) quickstarter with https://expressjs.com/[express] using http://www.typescriptlang.org/[Typescript].
This is a https://nodejs.org/en/[Node.js] (v20) quickstarter with https://expressjs.com/[express] using http://www.typescriptlang.org/[Typescript].
If you are doing non-blocking operation and does not have heavy algorithm/Job which consumes lots of CPU power, this could be an ideal fit.
It contains a basic setup for https://www.docker.com/[Docker], https://jenkins.io/[Jenkins], https://www.sonarqube.org/[SonarQube] and https://www.openshift.com/[OpenShift].

Expand Down Expand Up @@ -34,14 +34,14 @@ The package json is generated by simply using `npm init -y`, while the tsconfig
== Frameworks used

. https://expressjs.com/[Express ({caret}4.18.2)]
. https://jestjs.io/[Jest ({caret}29.5.0) for Unit Testing]
. http://www.typescriptlang.org/[Typescript ({caret}5.0.2)]
. https://jestjs.io/[Jest ({caret}29.7.0) for Unit Testing]
. http://www.typescriptlang.org/[Typescript ({caret}5.3.2)]

== Libraries
On top of the mentioned frameworks above, we use libraries:

. https://www.npmjs.com/package/jest-junit/[Jest Junit ({caret}15.0.0)]
. https://www.npmjs.com/package/@types/node[@types/node ({caret}18.15.10)]
. https://www.npmjs.com/package/jest-junit/[Jest Junit ({caret}16.0.0)]
. https://www.npmjs.com/package/@types/node[@types/node ({caret}20.10.0)]

== Node version
When you push your code, your runtime and test code will be compiled using node v10. After deployment the compiled code also runs in node v10. If you developed your code and tests using a different node version locally, this might cause some problems.
Expand Down Expand Up @@ -76,7 +76,7 @@ version: 1.0.1
type: ods
role: backend
runtime: node
runtimeVersion: 18
runtimeVersion: 20
```


Expand All @@ -91,7 +91,7 @@ include::partial$secret-scanning-with-gitleaks.adoc

== Builder agent used

This quickstarter uses https://github.com/opendevstack/ods-quickstarters/tree/master/common/jenkins-agents/nodejs18[Node.JS 18 builder agent] for Jenkins.
This quickstarter uses https://github.com/opendevstack/ods-quickstarters/tree/master/common/jenkins-agents/nodejs20[Node.JS 20 builder agent] for Jenkins.

== Known limitations

Expand Down
6 changes: 3 additions & 3 deletions docs/modules/quickstarters/pages/e2e-cypress.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,9 @@ A more advanced solution could be the use of a custom builder agent, where Cypre
[source,docker]
----
# The following FROM tag is informational. It is overwritten by OpenShift.
FROM ods/jenkins-agent-nodejs18:4.x
FROM ods/jenkins-agent-nodejs20:4.x
ARG cypressVersion=12.9.0
ARG cypressVersion=13.6.0
ARG cypressHash=...
USER root
Expand Down Expand Up @@ -129,7 +129,7 @@ include::partial$secret-scanning-with-gitleaks.adoc
== Builder agent used

This quickstarter uses
https://github.com/opendevstack/ods-quickstarters/tree/master/common/jenkins-agents/nodejs18[Node.js 18 builder agent] for Jenkins.
https://github.com/opendevstack/ods-quickstarters/tree/master/common/jenkins-agents/nodejs20[Node.js 20 builder agent] for Jenkins.

== Known limitations

Expand Down
4 changes: 2 additions & 2 deletions docs/modules/quickstarters/pages/fe-angular.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ version: 1.0.1
type: ods
role: frontend
runtime: angular-cli
runtimeVersion: 15.2.7
runtimeVersion: 17.0.3
```

== How this quickstarter is built through Jenkins
Expand All @@ -91,7 +91,7 @@ include::partial$secret-scanning-with-gitleaks.adoc

== Builder agent used

This quickstarter uses https://github.com/opendevstack/ods-quickstarters/tree/master/common/jenkins-agents/nodejs18[Node.js 18 builder agent] for Jenkins.
This quickstarter uses https://github.com/opendevstack/ods-quickstarters/tree/master/common/jenkins-agents/nodejs20[Node.js 20 builder agent] for Jenkins.

== Known limitations

Expand Down
8 changes: 4 additions & 4 deletions docs/modules/quickstarters/pages/fe-ionic.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Ionic quickstarter project

== Purpose of this quickstarter

This quickstarter generates an *Ionic 6.19.0* project, you can use it when you want to develop a cross platform mobile app (iOS, android and PWA) in one codebase using Web technologies like CSS, HTML and JavaScript/TypeScript.
This quickstarter generates an *Ionic 7.1.5* project, you can use it when you want to develop a cross platform mobile app (iOS, android and PWA) in one codebase using Web technologies like CSS, HTML and JavaScript/TypeScript.

It contains the basic setup for https://www.docker.com/[Docker], https://jenkins.io/[Jenkins], https://www.sonarqube.org/[SonarQube] and https://www.openshift.com/[OpenShift], so you have your CI/CD process out of the box.

Expand Down Expand Up @@ -98,10 +98,10 @@ Note that the xref:jenkins-shared-library:labelling.adoc[OpenShift resources wil
name: Ionic
component: frontend
instance: <the component id (this is the default, if omitted)>
description: "Ionic Framework is the free, open source mobile UI toolkit for developing high-quality cross-platform apps for native iOS, Android, and the web—all from a single codebase. Technologies: Ionic 6.19.x"
description: "Ionic Framework is the free, open source mobile UI toolkit for developing high-quality cross-platform apps for native iOS, Android, and the web—all from a single codebase. Technologies: Ionic 7.1.5"
supplier: https://ionicframework.com
type: ods
version: 6.19.x
version: 7.1.5
```

== How this quickstarter is built thru Jenkins
Expand All @@ -119,7 +119,7 @@ include::partial$secret-scanning-with-gitleaks.adoc

== Builder agent used

This quickstarter uses https://github.com/opendevstack/ods-quickstarters/tree/master/common/jenkins-agents/nodejs16[Node.js 16 builder agent] for Jenkins.
This quickstarter uses https://github.com/opendevstack/ods-quickstarters/tree/master/common/jenkins-agents/nodejs20[Node.js 20 builder agent] for Jenkins.

== Known Limitation

Expand Down
2 changes: 1 addition & 1 deletion fe-angular/files/metadata.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Angular
description: "Angular is a TypeScript-based open-source web application framework led by the Angular Team at Google and by a community of individuals and corporations. Technologies: Angular 17.0"
description: "Angular is a TypeScript-based open-source web application framework led by the Angular Team at Google and by a community of individuals and corporations. Technologies: Angular 17.0.3"
supplier: https://angular.io
version: 4.x
type: ods
2 changes: 1 addition & 1 deletion fe-ionic/files/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Ionic Quickstarter
Quickstarter created with Ionic CLI 7.1.1
Quickstarter created with Ionic CLI 7.1.5

## Running unit tests
All files with the ending `.spec.ts` in the src folder will be tested with karma
Expand Down

0 comments on commit 6dc72de

Please sign in to comment.