Skip to content

Give every generated guide snippet a copyright header - #5702

Open
shai-almog wants to merge 1 commit into
masterfrom
devguide-snippet-headers
Open

Give every generated guide snippet a copyright header#5702
shai-almog wants to merge 1 commit into
masterfrom
devguide-snippet-headers

Conversation

@shai-almog

Copy link
Copy Markdown
Collaborator

226 of the 618 files under snippets/generated had no copyright header at all.

check-copyright-headers.sh is diff-scoped, so it only ever looked at those files
when a PR happened to touch one. That turned the omission into a surprise CI failure
three separate times while restoring code samples — each time in a file whose actual
change was a line or two of Java, and each time costing a round trip.

The header is the Codename One GPLv2 with Classpath exception, copied verbatim from a
file in the same directory that already passes the gate, so nothing new is invented. The
2012 form is what 315 of the already-headered files here use, and 747 files across
CodenameOne/src; the 77 carrying 2026 are left alone. Easy to overrule if you'd rather
new headers carried the current year — say so and I'll reroll.

The change is strictly additive and mechanical:

  • 226 files, +5198 / −0 — exactly 23 lines at the top of each
  • every added line is part of the comment block (verified by filtering the diff)
  • each file's own line endings preserved (all 226 turned out to be LF)

Verified locally: demos compile plus the bytecode compliance check, validate-guide-snippets
still resolves all 1028 include-backed blocks, control-character check clean over all 226,
and check-copyright-headers.sh --base origin/master now reports 226 passed.

Touches no shared file — no ratchet baseline, no workflow, no chapter — so it's disjoint
from #5698.

🤖 Generated with Claude Code

226 of the 618 files under snippets/generated had no header at all. The gate is
diff-scoped, so it only ever looked at them when a PR happened to touch one --
which meant the omission surfaced as a surprise failure three times while
restoring code samples, each time in a file whose actual change was a line or
two of Java.

The header is the Codename One GPLv2 with Classpath exception, copied verbatim
from a file in the same directory that already passes, so nothing new is being
invented. The 2012 form is the one used by 315 of the already-headered files
here and 747 across CodenameOne/src; the 77 carrying 2026 are left as they are.

The change is exactly additive: 23 lines at the top of each file and nothing
else, with each file's own line endings preserved.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 4, 2026

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review Completed 2026-09-04T18:44:32.228833Z 9adf05d PR opened
ℹ️ 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" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@github-actions

github-actions Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

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

Developer Guide quality checks:

  • AsciiDoc linter: No issues found (report)
  • Vale: No alerts found (report)
  • Paragraph capitalization: No paragraph capitalization issues (report)
  • LanguageTool: No grammar matches (report)
  • Image references: No unused images detected (report)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant