Add CI validation for Java 25 markdown doc comments by liannacasper · Pull Request #4749 · codenameone/CodenameOne

liannacasper · 2026-04-14T12:59:32Z

Motivation

Enforce the repository-wide move to Java 25 markdown doc comments (///) by preventing new classic Javadoc block openings (/**) from being introduced.
Prevent re-introducing legacy package.html Javadoc pages and require package-info.java with markdown doc comments instead.

Description

Add a new validation script ./.github/scripts/validate-java25-markdown-docs.sh that compares changes between two SHAs and flags newly added/renamed package.html files or added Java lines that open a /** block.
Wire the validation script into the PR CI by adding a step to .github/workflows/pr.yml so it runs immediately after checkout and receives DOCSTYLE_BASE_SHA/DOCSTYLE_HEAD_SHA from the workflow environment.
The script falls back to HEAD^..HEAD for local invocation when SHA bounds are not provided.

Testing

Ran the validation script locally with ./.github/scripts/validate-java25-markdown-docs.sh and it returned success, reporting no introduced /** blocks or package.html additions.
The new CI step is present in pr.yml so the same automated validation will execute inside GitHub Actions on pull requests and pushes.

Codex Task

github-actions · 2026-04-14T14:28:19Z

✅ Continuous Quality Report

Test & Coverage

✅ Tests: 2379 total, 0 failed, 0 skipped
📊 Line coverage: 53.43% [HTML preview] [Download]
- Lowest covered classes
  - com.codename1.ui.Display$EdtException – 0.00%
  - com.codename1.ui.plaf.CSSBorder$LinearGradient – 0.00%
  - com.codename1.util.EasyThread$InQueueRunnable – 0.00%
  - com.codename1.components.FloatingActionButton$ReleaseActionListener – 0.00%
  - com.codename1.io.Oauth2$ShowAuthenticationActionListener – 0.00%
  - com.codename1.io.Oauth2$RefreshTokenActionListener – 0.00%
  - com.codename1.util.EasyThread$RunAndWaitRunnable – 0.00%
  - com.codename1.components.ToastBar$FlushAnimationCallback – 0.00%
  - com.codename1.ui.plaf.CSSBorder$ColorStop – 0.00%
  - com.codename1.ui.ElevationComparator – 0.00%

Static Analysis

SpotBugs [HTML preview] [Download]
- ❌ ByteCodeTranslator: 110 findings (High: 2, Normal: 81, Low: 27)
  - Top findings
    - High: com/codename1/tools/translator/BytecodeMethod.java:647 – Method com.codename1.tools.translator.BytecodeMethod.findWritableFields(Set) seems to be useless (rule: UC_USELESS_VOID_METHOD)
    - High: com/codename1/tools/translator/bytecodes/TryCatch.java:91 – Write to static field com.codename1.tools.translator.bytecodes.TryCatch.hasTryCatch from instance method com.codename1.tools.translator.bytecodes.TryCatch.appendInstruction(StringBuilder, List) (rule: ST_WRITE_TO_STATIC_FROM_INSTANCE_METHOD)
    - Normal: com/codename1/tools/translator/ByteCodeClass.java:1808 – com.codename1.tools.translator.ByteCodeClass.getBaseClassObject() may expose internal representation by returning ByteCodeClass.baseClassObject (rule: EI_EXPOSE_REP)
    - …and 107 more
- ❌ android: 414 findings (High: 24, Normal: 196, Low: 194)
  - Top findings
    - High: CodenameOne/src/com/codename1/impl/CodenameOneThread.java:48 – com.codename1.impl.CodenameOneThread.STACK_FRAME_SIZE isn't final but should be (rule: MS_SHOULD_BE_FINAL)
    - High: com/codename1/impl/android/AndroidImplementation.java:1085 – Write to static field com.codename1.impl.android.AndroidImplementation.context from instance method com.codename1.impl.android.AndroidImplementation.setContext(Context) (rule: ST_WRITE_TO_STATIC_FROM_INSTANCE_METHOD)
    - High: com/codename1/impl/android/AndroidImplementation.java:1286 – com.codename1.impl.android.AndroidImplementation.isDarkMode() has Boolean return type and returns explicit null (rule: NP_BOOLEAN_RETURN_NULL)
    - …and 411 more
- ❌ codenameone-maven-plugin: 496 findings (High: 1, Normal: 319, Low: 176)
  - Top findings
    - High: com/codename1/maven/AbstractCN1Mojo.java:807 – com.codename1.maven.AbstractCN1Mojo.OS isn't final but should be (rule: MS_SHOULD_BE_FINAL)
    - Normal: com/codename1/builders/AndroidGradleBuilder.java:1020 – Dead store to googleServicesJson in com.codename1.builders.AndroidGradleBuilder.build(File, BuildRequest) (rule: DLS_DEAD_LOCAL_STORE)
    - Normal: com/codename1/builders/AndroidGradleBuilder.java:1045 – Possible null pointer dereference in com.codename1.builders.AndroidGradleBuilder.build(File, BuildRequest) due to return value of called method (rule: NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE)
    - …and 493 more
- ❌ core-unittests: 1 findings (Normal: 1)
  - Top findings
    - Normal: CodenameOne/src/com/codename1/ui/util/MutableResource.java:239 – com.codename1.ui.util.MutableResource.saveL10N(DataOutputStream, Hashtable) makes inefficient use of keySet iterator instead of entrySet iterator (rule: WMI_WRONG_MAP_ITERATOR)
- ❌ ios: 125 findings (High: 4, Normal: 75, Low: 46)
  - Top findings
    - High: com/codename1/impl/ios/IOSImplementation.java:1228 – com.codename1.impl.ios.IOSImplementation.isDarkMode() has Boolean return type and returns explicit null (rule: NP_BOOLEAN_RETURN_NULL)
    - High: com/codename1/impl/ios/IOSImplementation.java:128 – com.codename1.impl.ios.IOSImplementation.nativeInstance isn't final but should be (rule: MS_SHOULD_BE_FINAL)
    - High: com/codename1/impl/ios/IOSImplementation.java:214 – Write to static field com.codename1.impl.ios.IOSImplementation.instance from instance method com.codename1.impl.ios.IOSImplementation.init(Object) (rule: ST_WRITE_TO_STATIC_FROM_INSTANCE_METHOD)
    - …and 122 more
✅ PMD: 0 findings (no issues) [Report archive]
✅ Checkstyle: 0 findings (no issues) [Report archive]

Generated automatically by the PR CI workflow.

shai-almog · 2026-04-14T18:59:17Z

Compared 37 screenshots: 37 matched.

Native Android coverage

📊 Line coverage: 7.80% (4102/52607 lines covered) [HTML preview] (artifact android-coverage-report, jacocoAndroidReport/html/index.html)
- Other counters: instruction 6.12% (20282/331632), branch 2.92% (933/31974), complexity 3.64% (1115/30630), method 6.40% (915/14308), class 10.58% (201/1899)
- Lowest covered classes
  - kotlin.collections.kotlin.collections.ArraysKt___ArraysKt – 0.00% (0/6327 lines covered)
  - kotlin.collections.unsigned.kotlin.collections.unsigned.UArraysKt___UArraysKt – 0.00% (0/2384 lines covered)
  - org.jacoco.agent.rt.internal_b6258fc.asm.org.jacoco.agent.rt.internal_b6258fc.asm.ClassReader – 0.00% (0/1519 lines covered)
  - kotlin.collections.kotlin.collections.CollectionsKt___CollectionsKt – 0.00% (0/1148 lines covered)
  - org.jacoco.agent.rt.internal_b6258fc.asm.org.jacoco.agent.rt.internal_b6258fc.asm.MethodWriter – 0.00% (0/923 lines covered)
  - kotlin.sequences.kotlin.sequences.SequencesKt___SequencesKt – 0.00% (0/730 lines covered)
  - kotlin.text.kotlin.text.StringsKt___StringsKt – 0.00% (0/623 lines covered)
  - org.jacoco.agent.rt.internal_b6258fc.asm.org.jacoco.agent.rt.internal_b6258fc.asm.Frame – 0.00% (0/564 lines covered)
  - kotlin.collections.kotlin.collections.ArraysKt___ArraysJvmKt – 0.00% (0/495 lines covered)
  - kotlinx.coroutines.kotlinx.coroutines.JobSupport – 0.00% (0/423 lines covered)

✅ Native Android screenshot tests passed.

Native Android coverage

📊 Line coverage: 7.80% (4102/52607 lines covered) [HTML preview] (artifact android-coverage-report, jacocoAndroidReport/html/index.html)
- Other counters: instruction 6.12% (20282/331632), branch 2.92% (933/31974), complexity 3.64% (1115/30630), method 6.40% (915/14308), class 10.58% (201/1899)
- Lowest covered classes
  - kotlin.collections.kotlin.collections.ArraysKt___ArraysKt – 0.00% (0/6327 lines covered)
  - kotlin.collections.unsigned.kotlin.collections.unsigned.UArraysKt___UArraysKt – 0.00% (0/2384 lines covered)
  - org.jacoco.agent.rt.internal_b6258fc.asm.org.jacoco.agent.rt.internal_b6258fc.asm.ClassReader – 0.00% (0/1519 lines covered)
  - kotlin.collections.kotlin.collections.CollectionsKt___CollectionsKt – 0.00% (0/1148 lines covered)
  - org.jacoco.agent.rt.internal_b6258fc.asm.org.jacoco.agent.rt.internal_b6258fc.asm.MethodWriter – 0.00% (0/923 lines covered)
  - kotlin.sequences.kotlin.sequences.SequencesKt___SequencesKt – 0.00% (0/730 lines covered)
  - kotlin.text.kotlin.text.StringsKt___StringsKt – 0.00% (0/623 lines covered)
  - org.jacoco.agent.rt.internal_b6258fc.asm.org.jacoco.agent.rt.internal_b6258fc.asm.Frame – 0.00% (0/564 lines covered)
  - kotlin.collections.kotlin.collections.ArraysKt___ArraysJvmKt – 0.00% (0/495 lines covered)
  - kotlinx.coroutines.kotlinx.coroutines.JobSupport – 0.00% (0/423 lines covered)

Benchmark Results

Detailed Performance Metrics

Metric	Duration
Base64 payload size	8192 bytes
Base64 benchmark iterations	6000
Base64 native encode	1011.000 ms
Base64 CN1 encode	242.000 ms
Base64 encode ratio (CN1/native)	0.239x (76.1% faster)
Base64 native decode	1047.000 ms
Base64 CN1 decode	372.000 ms
Base64 decode ratio (CN1/native)	0.355x (64.5% faster)

shai-almog · 2026-04-14T19:11:39Z

iOS screenshot updates

Compared 37 screenshots: 36 matched, 1 updated.

landscape — updated screenshot. Screenshot differs (2556x1179 px, bit depth 8).

Preview info: Preview provided by instrumentation.
Full-resolution PNG saved as landscape.png in workflow artifacts.

Benchmark Results

VM Translation Time: 0 seconds
Compilation Time: 174 seconds

Detailed Performance Metrics

Metric	Duration
Simulator Boot	1000 ms
Simulator Boot (Run)	1000 ms
App Install	5000 ms
App Launch	11000 ms
Test Execution	205000 ms
Base64 payload size	8192 bytes
Base64 benchmark iterations	6000
Base64 native encode	1632.000 ms
Base64 CN1 encode	1923.000 ms
Base64 encode ratio (CN1/native)	1.178x (17.8% slower)
Base64 native decode	1102.000 ms
Base64 CN1 decode	1212.000 ms
Base64 decode ratio (CN1/native)	1.100x (10.0% slower)

Add CI validation for Java 25 markdown doc style

278341e

liannacasper added the codex label Apr 14, 2026 — with ChatGPT Codex Connector

liannacasper added 4 commits April 14, 2026 16:47

Make markdown doc validation script repo-root aware

06597a8

Improve git root detection in docs validation script

9973616

Add GitHub API fallback for markdown docs validation

b8ac358

Simplify markdown docs validation to full-tree grep

359679b

liannacasper added 4 commits April 14, 2026 20:17

Make markdown docs validator run from repo root

16ed086

Fail docs validator on missing tools and wrong cwd

17e1582

Remove legacy package.html and remaining /** doc blocks

7284579

Fix broken comment block in GroupLayout

9063411

liannacasper merged commit f2f0a31 into master Apr 15, 2026
16 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add CI validation for Java 25 markdown doc comments#4749

Add CI validation for Java 25 markdown doc comments#4749
liannacasper merged 9 commits intomasterfrom
codex/enforce-java-25-markdown-comment-validation

liannacasper commented Apr 14, 2026

Uh oh!

github-actions bot commented Apr 14, 2026 •

edited

Loading

Uh oh!

shai-almog commented Apr 14, 2026 •

edited

Loading

Uh oh!

shai-almog commented Apr 14, 2026 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

liannacasper commented Apr 14, 2026

Motivation

Description

Testing

Uh oh!

github-actions bot commented Apr 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Continuous Quality Report

Test & Coverage

Static Analysis

Uh oh!

shai-almog commented Apr 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Native Android coverage

Native Android coverage

Benchmark Results

Detailed Performance Metrics

Uh oh!

shai-almog commented Apr 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

iOS screenshot updates

Benchmark Results

Detailed Performance Metrics

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

github-actions bot commented Apr 14, 2026 •

edited

Loading

shai-almog commented Apr 14, 2026 •

edited

Loading

shai-almog commented Apr 14, 2026 •

edited

Loading