Skip to content

Commit

Permalink
Placate linter
Browse files Browse the repository at this point in the history
Signed-off-by: Stewart X Addison <sxa@redhat.com>
  • Loading branch information
sxa committed Nov 4, 2024
1 parent b72aaf3 commit b5c58c4
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Eclipse Adoptium makes use of these scripts to build binaries on the build farm

This repository contains several useful scripts in order to build OpenJDK
personally or at build farm scale via jenkins. For the Temurin project at
Adoptium, this is done with the jenkins instance at https://ci.adoptium.net
Adoptium, this is done with the jenkins instance at [ci.adoptium.net](https://ci.adoptium.net)

1. The `docs` folder contains images and utility scripts to produce up to date
documentation.
Expand Down Expand Up @@ -49,13 +49,13 @@ The betaTrigger_XXea jobs use
[trigger_beta_build.groovy](https://github.com/adoptium/ci-jenkins-pipelines/blob/master/pipelines/build/common/trigger_beta_build.groovy)
to determine when to run a build. This contains a trap for the expected GA
release times to prevent triggering so that machine time is not used up
while we are performing release build and test cycles.
while we are performing release build and test cycles.

Once complete, the openjdkXX-pipelines which will, by default, invoke the
separate
([refactor_openjdk_release_tool](https://ci.adoptium.net/job/build-scripts/job/release/job/refactor_openjdk_release_tool/))
job which will publish them as an `ea-beta`-suffixed release in github under e.g.
[temurin-21-binaries](https://github.com/adoptium/temurin21-binaries/releases?q=ea-beta&expanded=true}).
job which will publish them as an `ea-beta`-suffixed release in github under e.g.
[temurin-21-binaries](https://github.com/adoptium/temurin21-binaries/releases?q=ea-beta&expanded=true}).

### release-openjdkXX-pipeline

Expand All @@ -77,6 +77,7 @@ using the readExpectedGATag function in
[common.sh](https://github.com/adoptium/mirror-scripts/blob/master/common.sh)

A couple of points to note on the release configurations:

- [jdk8u_release.groovy](https://github.com/adoptium/ci-jenkins-pipelines/blob/master/pipelines/jobs/configurations/jdk8u_release.groovy),
[jdk11u_release.groovy](https://github.com/adoptium/ci-jenkins-pipelines/blob/master/pipelines/jobs/configurations/jdk11u_release.groovy)
and [jdk17u_release.groovy](https://github.com/adoptium/ci-jenkins-pipelines/blob/master/pipelines/jobs/configurations/jdk11u_release.groovy)
Expand All @@ -87,6 +88,7 @@ A couple of points to note on the release configurations:
does not include arm32, since that is built from a separate codebase and
is tagged separately so cannot generally be triggered alongside the main
builds.

### evaluation-openjdkXX-pipeline

These are similar to the openjdkXX-pipeline jobs, and are triggered from the
Expand Down
7 changes: 3 additions & 4 deletions pipelines/jobs/configurations/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Configuration Files used by the build job generators
# Configuration Files used by the build job generators

*Note: The contents of this file was split out from the top level README.md in this repository*
Note: The contents of this file was split out from the top level README.md in this repository

The [pipelines/jobs/configurations](pipelines/jobs/configurations) directory contains two categories of configuration files that our jenkins pipelines use (Nicknamed [#Build Configs](#build) and [#Nightly Configs](#nightly) for short).

Expand Down Expand Up @@ -45,7 +45,7 @@ NOTE: When the `type` field implies a map, the `String` key of the inner map is
| os | &#9989; | `String` | Operating system tag that will identify the job on jenkins and determine which platforms configs to pull from temurin-build.<br>*E.g. `windows`, `solaris`* |
| arch | &#9989; | `String` | Architecture tag that will identify the job on jenkins and determine which build params to use.<br>*E.g. `x64`, `sparcv9`, `x86-32`* |
| test | &#10060; | `String`<br>**OR**<br>`Map<String, List>`<br>**OR**<br>`Map<String, List or Map<String, List>>` | Case one: Tests to run against the binary after the build has completed. A `default` tag indicates that you want to run [whatever the default test nightly/release list is](https://github.com/adoptium/ci-jenkins-pipelines/blob/ab947ce6ab0ecd75ebfb95eb2f75facb83e4dc13/pipelines/build/common/build_base_file.groovy#L66-L88).<br><br>Case two: You can also [specify your own list for that particular platform (not variant)](https://github.com/adoptium/ci-jenkins-pipelines/blob/ab947ce6ab0ecd75ebfb95eb2f75facb83e4dc13/pipelines/jobs/configurations/jdk16_pipeline_config.groovy#L59-L64). <br><br>Case three: Or you can even [specify the list for that particular platform per variant](https://github.com/adoptium/ci-jenkins-pipelines/blob/master/pipelines/jobs/configurations/jdk8u_pipeline_config.groovy#L78-L81). The list could be specific one `sanity.openjdk` or `default` (similar to the first case) or a map per nightly or release (similar to case two). |
| testDynamic | &#10060; | `Boolean`<br>**OR**<br>`Map<String, ?>` | PARALLEL=Dynamic parameter setting. False : no Parallel. Or you can set the parameters with or without variant.
| testDynamic | &#10060; | `Boolean`<br>**OR**<br>`Map<String, ?>` | PARALLEL=Dynamic parameter setting. False : no Parallel. Or you can set the parameters with or without variant. |
| dockerImage | &#10060; | `String`<br>**OR**<br>`Map<String, String>` | Builds the JDK inside a docker container. Should be a DockerHub identifier to pull from in case **dockerFile** is not specified.<br>*E.g. `adoptopenjdk/centos6_build_image`* |
| dockerFile | &#10060; | `String`<br>**OR**<br>`Map<String, String>` | Builds the JDK inside a docker container using the locally stored image file. Used in conjunction with **dockerImage** to specify a particular variant to build or pull.<br>*E.g. `pipelines/build/dockerFiles/cuda.dockerfile`* |
| dockerNode | &#10060; | `String`<br>**OR**<br>`Map<String, String>` | Specifies a specific jenkins docker node label to shift into to build the JDK.<br> *E.g. `sw.config.uid1000`* |
Expand Down Expand Up @@ -189,4 +189,3 @@ weekly_evaluation_scmReferences== [
"dragonwell" : ""
]
```

0 comments on commit b5c58c4

Please sign in to comment.