Add developer guide documentation build workflow

[shai-almog]

Summary

• add a workflow that builds the developer guide HTML and PDF with Asciidoctor
• upload the generated documentation as PR artifacts and release assets
• comment on affected pull requests with direct links to the downloadable artifacts

Testing

• not run

---

https://chatgpt.com/codex/tasks/task_e_68f59290abc88331aacb054a59356751

[chatgpt-codex-connector]

💡 Codex Review

Here are some automated review suggestions for this pull request.

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

• Open a pull request for review
• Mark a draft as ready
• Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

[chatgpt-codex-connector]

Handle lack of write permissions on forked PR comment step

The workflow tries to call issues.createComment using the default GITHUB_TOKEN whenever it runs on a pull request. For PRs opened from forks, that token is read‑only and cannot write to issues or PRs. When such a forked PR touches the developer guide, this step will consistently fail with a 403, causing the entire workflow to report failure even though the documentation build succeeded and no comment was required. Consider guarding the comment step behind a permission check, switching to pull_request_target, or marking the step continue-on-error so forked contributions do not see a failing check.

Useful? React with 👍 / 👎.

[github-actions]

Developer Guide build artifacts are available for download from this workflow run:

• Developer Guide HTML package
• Developer Guide PDF

[github-actions]

✅ Continuous Quality Report

Test & Coverage

• ✅ Tests: 228 total, 0 failed, 0 skipped
• 📊 Line coverage: 10.26% [HTML preview] [Download]
  • Lowest covered classes
    • com.codename1.io.services.RSSService$1 – 0.00%
    • com.codename1.io.services.ImageDownloadService – 0.00%
    • com.codename1.io.services.ImageDownloadService$6 – 0.00%
    • com.codename1.io.services.ImageDownloadService$1 – 0.00%
    • com.codename1.io.services.ImageDownloadService$3 – 0.00%
    • com.codename1.io.services.ImageDownloadService$2 – 0.00%
    • com.codename1.io.services.ImageDownloadService$5 – 0.00%
    • com.codename1.io.services.ImageDownloadService$4 – 0.00%
    • com.codename1.io.services.TwitterRESTService$1 – 0.00%
    • com.codename1.io.services.RSSService$1FinishParsing – 0.00%

Static Analysis

• ❌ SpotBugs: 993 findings (High: 92, Normal: 484, Low: 417) [HTML preview] [Download]
  • Top findings
    • High: CodenameOne/src/com/codename1/charts/util/ColorUtil.java:38 – Field isn't final but should be (rule: MS_SHOULD_BE_FINAL)
    • High: CodenameOne/src/com/codename1/charts/util/ColorUtil.java:30 – Field isn't final but should be (rule: MS_SHOULD_BE_FINAL)
    • High: CodenameOne/src/com/codename1/charts/util/ColorUtil.java:33 – Field isn't final but should be (rule: MS_SHOULD_BE_FINAL)
    • High: CodenameOne/src/com/codename1/charts/views/XYChart.java:128 – Call to equals() comparing different types (rule: EC_UNRELATED_TYPES)
    • High: CodenameOne/src/com/codename1/compat/java/util/Objects.java:51 – Redundant nullcheck of value known to be non-null (rule: RCN_REDUNDANT_NULLCHECK_OF_NONNULL_VALUE)
    • …and 988 more
• ❌ PMD: 2726 findings (P2: 1, P3: 649, P4: 2076) [HTML preview] [Download]
  • Top findings
    • P2: CodenameOne/src/com/codename1/ui/Display.java:1012 – Avoid using a branching statement as the last in a loop. (rule: AvoidBranchingStatementAsLastInLoop)
    • P3: CodenameOne/src/com/codename1/facebook/FacebookRESTService.java:76 – Avoid unused constructor parameters such as 'token'. (rule: UnusedFormalParameter)
    • P3: CodenameOne/src/com/codename1/impl/CodenameOneImplementation.java:8380 – These nested if statements could be combined (rule: CollapsibleIfStatements)
    • P3: CodenameOne/src/com/codename1/impl/FullScreenAdService.java:103 – These nested if statements could be combined (rule: CollapsibleIfStatements)
    • P3: CodenameOne/src/com/codename1/io/CSVParser.java:134 – These nested if statements could be combined (rule: CollapsibleIfStatements)
    • …and 2721 more
• ❌ Checkstyle: 183474 findings (Warning: 183474) [HTML preview] [Download]
  • Top findings
    • Warning: CodenameOne/src/com/codename1/charts/models/XYSeries.java:3 –

      tag should be placed immediately before the first word, with no space after. (rule: JavadocParagraphCheck)

    • Warning: CodenameOne/src/com/codename1/charts/models/XYSeries.java:3 –

      tag should be preceded with an empty line. (rule: JavadocParagraphCheck)

    • Warning: CodenameOne/src/com/codename1/charts/models/XYSeries.java:7 –

      tag should be placed immediately before the first word, with no space after. (rule: JavadocParagraphCheck)

    • Warning: CodenameOne/src/com/codename1/charts/models/XYSeries.java:7 –

      tag should be preceded with an empty line. (rule: JavadocParagraphCheck)

    • Warning: CodenameOne/src/com/codename1/charts/models/XYSeries.java:9 –

      tag should be placed immediately before the first word, with no space after. (rule: JavadocParagraphCheck)

    • …and 183469 more

Generated automatically by the PR CI workflow.