Skip to content

Commit

Permalink
linter
Browse files Browse the repository at this point in the history
  • Loading branch information
gdams committed Jan 12, 2023
1 parent 1a674be commit 7431f54
Show file tree
Hide file tree
Showing 22 changed files with 132 additions and 128 deletions.
5 changes: 4 additions & 1 deletion .github/linters/.markdown-lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,7 @@ MD013: false # Line length is usually not important and the 80 char limit is way
MD026: false # Trailing punctuation in header
MD033: false # Inline HTML is important for multilines and checkboxes within markdown tables
MD034: false # no-bare-urls Bare URL used
MD029: false # Markdown automatically calculates the ordered list order
MD029: false # Markdown automatically calculates the ordered list order
MD036: false # Emphasis used instead of a heading
MD028: false # No blank lines inside blockquote
MD053: false # Link and image reference definitions should be needed
2 changes: 1 addition & 1 deletion .github/workflows/linter.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ jobs:

- name: Lint Code Base
uses: github/super-linter/slim@985ef206aaca4d560cb9ee2af2b42ba44adc1d55 # v4.10.0

env:
VALIDATE_ALL_CODEBASE: false
DEFAULT_BRANCH: main
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# Markdown lint complains about the issue templates
FILTER_REGEX_EXCLUDE: .github/ISSUE_TEMPLATE/*
VALIDATE_NATURAL_LANGUAGE: false
VALIDATE_YAML: false
14 changes: 10 additions & 4 deletions content/mdx-docs/docs/aqavit-verification/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,19 @@ The AQAvit project was created to “make quality certain to happen.” AQAvit v
AQAvit verification is one of the criteria for listing in the [Adoptium Marketplace](/marketplace). Leveraging the AQAvit test suite to ensure the quality of the binaries listed in the Adoptium Marketplace not only communicates to consumers how serious we are about quality, but also consolidates the good verification practices of the Adoptium Working Group members under a centralized effort. AQAvit aligns its test suite standards with the ever-changing requirements of the user base.

## Overview

The AQAvit test suite is a large set of tests, many contributed to the AQAvit project and some pulled from a variety of open-source projects, that serve to verify the quality of OpenJDK binaries. The suite is suitable for testing Java SE 8 or higher versions on all [supported platforms](/supported-platforms). To verify binaries, testers clone a specified release of the aqa-tests github repository (the [latest stable release](https://github.com/adoptium/aqa-tests/releases) of the aqa-tests repository), configure their test environment, execute and pass the required test targets against each binary they plan to verify and make the results of those test runs available as per the QVSL.

## AQAvit Test Targets to Run

The tests are divided into different groups and those groups are split into 3 levels. This logical categorization of the tests provides flexibility and granularity and can be visually represented in a grid.

![grid view](./gridview.png)

For the current release of AQAvit, the required set of top-level test targets to run are [sanity.functional, extended.functional, special.functional, sanity.openjdk, extended.openjdk, sanity.system, extended.system, sanity.perf, extended.perf]. In subsequent AQAvit releases, targets will be added to raise quality bar even higher.

## Details Regarding Test Execution

AQAvit can be run in various CI/CD environments as well as directly via command-line in a container or on a test machine that has the https://github.com/adoptium/aqa-tests/blob/master/doc/Prerequisites.md[test prerequisites^] installed. The basic steps are the same in any environment.

<Collapsible title='Run AQAvit via Command-line'>
Expand All @@ -45,11 +48,12 @@ Collect *.tap file and metadata file
Archive <results>.zip
Publish <results>.zip
```

</Collapsible>

<Collapsible title='Run AQAvit via Github Workflow'>

The AQAvit project created a Github action that allows for running the AQAvit test suite from workflow files. The `run-aqa` action in the [run-aqa repository](https://github.com/adoptium/run-aqa) allows users to pass in custom OpenJDK binaries for verification. Here is an example workflow file that can run sanity level targets on the 3 supported platforms available as GitHub runners:
The AQAvit project created a Github action that allows for running the AQAvit test suite from workflow files. The `run-aqa` action in the [run-aqa repository](https://github.com/adoptium/run-aqa) allows users to pass in custom OpenJDK binaries for verification. Here is an example workflow file that can run sanity level targets on the 3 supported platforms available as GitHub runners:

```yaml
name: Run AQAvit
Expand Down Expand Up @@ -92,6 +96,7 @@ jobs:
name: test_output
path: ./**/output_*/*.tap
```
</Collapsible>
<Collapsible title='Run AQAvit via Jenkins'>
Expand All @@ -113,18 +118,20 @@ Archive <results>.zip

Publish <results>.zip
```

</Collapsible>

The `.tap` files and metadata files contain timestamps and information about the binary under test. This information is collected from `java -version` output, release file information and querying some system properties during the test run. Where applicable, the information should match with the binary listed in the marketplace.

## Verifying Results

The AQAvit test suite produces test result files and metadata files at the end of the test execution. Upon running and passing each of the nine required test targets, the result files and metadata files are to be gathered and shared. For test targets that contain failures, the root cause of the failure should be addressed and the target can be rerun and an updated test result file produced and shared.

Test result files that are produced follow a certain naming convention and use a simple TAP (Test Anything Protocol). When top-level targets are run serially, a single .tap file is produced, for example:
Test result files that are produced follow a certain naming convention and use a simple TAP (Test Anything Protocol). When top-level targets are run serially, a single .tap file is produced, for example:

**Test_openjdk11_hs_sanity.system_aarch64_linux.tap**

contains version, impl/distribution, test target and platform information in the name, and its contents look like:
contains version, impl/distribution, test target and platform information in the name, and its contents look like:

```yaml
# Timestamp: Wed Mar 2 10:51:55 2022 UTC
Expand All @@ -151,7 +158,6 @@ ok 168 - MauveMultiThrdLoad_5m_1

One can see in this example that the top-level target sanity.system contains 168 sub-targets. Of the set of expected subtargets, some may be 'skipped' due to being filtered out as not applicable for a particular version or platform, but there must be none that failed. Within the tap file, they will show as 'not ok' if they have failed. Failing subtargets can be rerun individually and the tap file produced for that individual run can be included in the `<results>.zip` file to indicate that the binary under test was able to pass all expected targets.


<Collapsible title='AQAvit Verification Demonstration'>
<iframe class="pt-3" width="560" height="315" src="https://www.youtube.com/embed/1EUi3iTZSzg" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
</Collapsible>
5 changes: 4 additions & 1 deletion content/mdx-docs/docs/eca-sign-off/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ First, you need to create an Eclipse Foundation account.
You are one step away from becoming an Eclipse Contributor, we just need to sign the ECA.

### Sign the ECA

Signing the ECA is straightforward and is done online.

1. Navigate to the [login page](https://accounts.eclipse.org/user/login) of Eclipse Accounts page
Expand All @@ -32,17 +33,19 @@ Now the Status panel in the upper right corner should show that you signed the E
![one green dot at Eclipse Contributor Agreement](./Status_signed_ECA.png)

### ECA Sign check failed, but why?

For every pull request, a GitHub Action verifies that the author signed the Eclipse Contributor Agreement.
This can fail if:

* You have not got an Eclipse Account
* You have not signed the Eclipse Contributor Agreement
* You have configured git to use a different E-Mail address than you used to sign the ECA
* `user.email` setting for git must equal to that used for your Eclipse Foundation account. See [Setting your commit email address](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/setting-your-commit-email-address) for more information
* `user.email` setting for git must equal to that used for your Eclipse Foundation account. See [Setting your commit email address](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/setting-your-commit-email-address) for more information

If none of the above is the case, feel free to reach out to the maintainers.

### How to change the author E-Mail address for existing commits

In order for the ECA check to pass, all commits in the pull request must have been authored with the E-Mail address used to sign the ECA.

To change the author for the last commit:
Expand Down
35 changes: 16 additions & 19 deletions content/mdx-docs/docs/faq/index.es.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ authors: eddumelendez, czelabueno, jdluna, raulmj, tellison, gdams
---

Hemos reunido unas cuantas preguntas frecuentes (FAQs) en este documento.
Si quieres conversar con nosotros sobre estos tópicos, o realizar preguntas adicionales
Si quieres conversar con nosotros sobre estos tópicos, o realizar preguntas adicionales
el mejor lugar es vía [Slack](/slack) o levantando un issue en el
[canal de soporte](https://github.com/adoptium/adoptium-support).

Expand All @@ -16,14 +16,13 @@ uso están disponibles en nuestra [última página de versiones](/temurin/releas
También contamos con todos los gestores de instalación más populares de Java, como:
[Homebrew](https://formulae.brew.sh/cask/temurin), [SDKMAN](https://sdkman.io/),
[winget](https://github.com/microsoft/winget-cli), y [Chocolatey](https://chocolatey.org/), nosotros aparecemos en
[Imágenes docker oficiales](https://hub.docker.com/_/eclipse-temurin), y ud puede usar Temurin mediante el Github
[Imágenes docker oficiales](https://hub.docker.com/_/eclipse-temurin), y ud puede usar Temurin mediante el GitHub
["setup-java"](https://github.com/marketplace/actions/setup-java-jdk#basic)
action, y parte del soporte de Java de los proveedores de la nube.

Los instaladores de Linux están disponibles en packages.adoptium.net. Para más información ver [esta guía](/installation/linux).

Sí. Los binarios de Eclipse Temurin son proporcionados para su uso sin ningún costo por Adoptium, por siempre, bajo los términos de la "GNU General Public License, version 2 with the
Classpath Exception". Usted puede utilizar, modificar y compartir libremente el código como se describe en las licencias incluidas en la descarga.
Sí. Los binarios de Eclipse Temurin son proporcionados para su uso sin ningún costo por Adoptium, por siempre, bajo los términos de la "GNU General Public License, version 2 with the Classpath Exception". Usted puede utilizar,modificar y compartir libremente el código como se describe en las licencias incluidas en la descarga.

## ¿Cómo puedo ayudar en el proyecto?

Expand All @@ -36,11 +35,11 @@ El equipo de Adoptium ayuda en muchas maneras. Por ejemplo:

* Recibimos apoyo técnico y creativo en el proyecto para avanzar en nuestras metas
a través de promociones y marketing, escribiendo blogs sobre experiencias con Adoptium,
respondiendo preguntas en nuestro [Comunidad de Slack activa](/slack), ayudando en
las pruebas de software y diagnosticando problemas, y
respondiendo preguntas en nuestro [Comunidad de Slack activa](/slack), ayudando en
las pruebas de software y diagnosticando problemas, y
[solucionando algunos issues](/docs/first-timer-support) que han sido reportados.

* Muchas otras formas ya sea como única aventura o miembro de equipo a largo plazo, únete
* Muchas otras formas ya sea como única aventura o miembro de equipo a largo plazo, únete
y comparte tus ideas!

## ¿Por cuánto tiempo será soportado Eclipse Temurin?
Expand All @@ -52,8 +51,8 @@ Nuestra frecuencia de release y nuestra declaración de soporte está disponible
Sí. Cada release de Temurin ha pasado el relevante Oracle Java Compatibility Kit (JCK)
para demostrar que es una implementación compatible de la especificación Java.
Adicionalmente, los releases de Temurin deben pasar el [AQAvit quality verification suite](/aqavit)
para asegurarse que estan listos para su uso en producción. Las pruebas AQAvit verifican si el release muestra
una gran rendimiento, seguridad, resiliencia y resistencia, y la habilidad de pasar una gran variedad de pruebas
para asegurarse que estan listos para su uso en producción. Las pruebas AQAvit verifican si el release muestra
una gran rendimiento, seguridad, resiliencia y resistencia, y la habilidad de pasar una gran variedad de pruebas
de compatibilidad de aplicaciones.

## ¿Dónde puedo reportar un error o problema con Eclipse Temurin?
Expand All @@ -68,30 +67,28 @@ y los problemas se abordarán sobre la base del mejor esfuerzo. Debe dirigirse a
Tenemos una lista de variantes en nuestro
[repositorio oficial de Docker](https://hub.docker.com/_/eclipse-temurin) para asegurar que nosotros
respondemos a la entrega de nuevas imágenes que contienen Temurin. Los usuarios
que quieren una distribución de Linux en contenedores que no proporcionamos
que quieren una distribución de Linux en contenedores que no proporcionamos
pueden seguir las instrucciones en [esta guia](/blog/2021/08/using-jlink-in-dockerfiles/).

## ¿Soportarán mi arquitectura y sistema operativo favoritos?

Eclipse Temurin tiene la gama más amplia de soporte a plataformas a través de las múltiples versiones de
Eclipse Temurin tiene la gama más amplia de soporte a plataformas a través de las múltiples versiones de
la API de Java. Cada nueva plataforma incurre en costos adicionales y de
demanda en los recursos del proyecto, asi que constantemente
revisamos la demanda por descargas y uso para asegurarnos que estamos liberando en plataformas relevantes hacia
un gran grupo de usuarios. El conjunto actual de plataformas al que nos dirigimos en nuestros procesos de prueba
revisamos la demanda por descargas y uso para asegurarnos que estamos liberando en plataformas relevantes hacia
un gran grupo de usuarios. El conjunto actual de plataformas al que nos dirigimos en nuestros procesos de prueba
y build está listado [aquí](/supported-platforms).

## ¿Puedo automatizar la descarga de los binarios de Temurin?

Sí! Se cuenta con una [API](https://api.adoptium.net/q/swagger-ui/)
que Adoptium provee para la descarga de Eclipse Temurin. Usando la API es posible obtener
información sobre las últimas compilaciones de Temurin, y obtenerlas en tu propia
aplicación.
información sobre las últimas compilaciones de Temurin, y obtenerlas en tu propia aplicación.

## ¿Qué significa el nombre de "Eclipse Temurin"?

Este es el nombre del proyecto y la marca para los binarios producidos por la Fundación
de Eclipse.
Mientras apreciamos que la separación del nombre Adoptium/Temurin es más confusa que solamente
de Eclipse. Mientras apreciamos que la separación del nombre Adoptium/Temurin es más confusa que solamente
"Adoptium", esto es similar a como otros fabricantes nombran sus binarios, por ejemplo, Amazon
tiene Corretto, Azul tiene Zulu (y otros). El proyecto "Adoptium" y grupo de trabajo se
ocupará de más que solo Temurin, asi que la distinción es importante de mencionar.
Expand All @@ -101,7 +98,7 @@ ocupará de más que solo Temurin, asi que la distinción es importante de menci
Los desarrollos de AdoptOpenJDK se conocen ahora como "Eclipse Temurin by
Adoptium"([leer el blog post](/blog/2021/08/adoptium-celebrates-first-release/)).
Sin embargo, no te preocupes, a pesar de los cambios de marca, se tratan de los mismos procesos de desarrollo abiertos,
suites de prueba de AQAvit y principalmente el mismo equipo de producción que antes,
suites de prueba de AQAvit y principalmente el mismo equipo de producción que antes,
pero hay [compañías mas grandes](/members) que aportan su experiencia
al grupo de trabajo.

Expand All @@ -124,7 +121,7 @@ No hay necesidad de preocuparse acerca del cambio - sigue siendo libre.

Los acuerdos en los que nos movemos dentro de la Fundaóion Eclipse significan
que ya no podemos incluir IcedTea-Web en nuestros instaladores.
Sin embargo, Ud. todavía puede agregar la funcionalidad si lo necesita usar
Sin embargo, Ud. todavía puede agregar la funcionalidad si lo necesita usar
[instrucciones aquí](https://blog.adoptopenjdk.net/2018/10/using-icedtea-web-browser-plug-in-with-adoptopenjdk/).

## ¿Puede dar una charla sobre el proyecto?
Expand Down
9 changes: 5 additions & 4 deletions content/mdx-docs/docs/faq/index.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ authors: zdtsw, gdams, tellison
Adoptium 的 JDK 称为 Eclipse Temurin,推荐您使用我们的 [最新版本](/temurin/releases/)

我们还为各大Java 安装管理器提供功能,例如:
[Homebrew](https://formulae.brew.sh/cask/temurin),
[Homebrew](https://formulae.brew.sh/cask/temurin),
[SDKMAN](https://sdkman.io/),
[winget](https://github.com/microsoft/winget-cli)
[Chocolatey](https://chocolatey.org/)
[winget](https://github.com/microsoft/winget-cli),
[Chocolatey](https://chocolatey.org/),
[official Docker images](https://hub.docker.com/_/eclipse-temurin),
您还可以通过 Github 使用 Temurin ["setup-java"](https://github.com/marketplace/actions/setup-java-jdk#basic) action,
另外它也是云提供商 Java 支持的一部分。
Expand Down Expand Up @@ -48,6 +48,7 @@ Adoptium 提供 [下载 API](https://api.adoptium.net/q/swagger-ui/) 可以自
使用API可以获得有关 Temurin 最新版本的信息,并将它们加载到您的应用程序中。

## 为何命名为"Eclipse Temurin"?

Eclipse Temurin 是 Eclipse Foundation 生成的二进制文件的项目和品牌名称

将名称拆分为 Adoptium/Temurin 比 Adoptium 更令人困惑,但其他供应商也使用类似方式。例如,Amazon 有 Corretto,Azul 有 Zulu 等等。
Expand All @@ -63,7 +64,7 @@ Adoptium 项目和工作组将处理的不仅仅是 Temurin,这就是为什么

## 如何找到 Eclipse OpenJ9 构建?

不幸的是,我们无法继续分发 Eclipse OpenJ9 的构建。
不幸的是,我们无法继续分发 Eclipse OpenJ9 的构建。
IBM 现在已经接管了 OpenJ9,并且命名为 "[IBM Semeru](https://developer.ibm.com/languages/java/semeru-runtimes/)"。
用户无需担心此项变动 - 它仍然是免费的。

Expand Down
2 changes: 1 addition & 1 deletion content/mdx-docs/docs/first-timer-support/index.de.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Außerdem sollten wir alle diese Probleme mit **`help wanted`** und **`Hacktober
## Links & Resources

- [List of all issues that are labeled by **`good first issue`**](https://github.com/issues?q=org%3AAdoptium+label%3A%22good+first+issue%22+is%3Aopen)
- [List of all issues that are labeled by **`good first issue - candidate `**](https://github.com/issues?q=org%3AAdoptium+label%3A%22good+first+issue+-+candidate%22+is%3Aopen)
- [List of all issues that are labeled by **`good first issue - candidate`**](https://github.com/issues?q=org%3AAdoptium+label%3A%22good+first+issue+-+candidate%22+is%3Aopen)
- [Current version of the issue template](https://gist.github.com/hendrikebbers/8e4dec9ddea5e2a420080d1314af025f)
- [Current version of a section about "First timers support" for contributing.md files](https://gist.github.com/hendrikebbers/0f9cdd18076343b3bbe5f2d162733b6e)
- https://github.com/AdoptOpenJDK/IcedTea-Web/issues/706[An example of a **`good first issue`**]
Loading

0 comments on commit 7431f54

Please sign in to comment.