Modernize developer guide demos and snippets#5324
Open
shai-almog wants to merge 43 commits into
Open
Conversation
shai-almog
changed the title
![github-code-quality[bot]](https://avatars.githubusercontent.com/u/9919?s=60&v=4){kind=small}
Contributor
Cloudflare Preview
|
Contributor
|
Developer Guide build artifacts are available for download from this workflow run:
Developer Guide quality checks: |
Contributor
✅ Continuous Quality ReportTest & Coverage
Static Analysis
Generated automatically by the PR CI workflow. |
…eloper-guide-demos
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/demosto Java 17 and the8.0-SNAPSHOTCodename One plugin/runtime.docs/demos, with compiled examples in realsrc/main/javasources and guide-only snippet bundles stored as.java.txtso they are not mistaken for Java compilation units.../demos/, and guide-only snippet bundles cannot regress to.javafiles.Why
The developer guide demo project was still on Java 8 / Codename One 7.x and only covered a small fraction of the guide. This made snippets and screenshots drift from the current project templates. The guide now has demo-backed source includes, real compiled sources for executable guide snippets, and CI paths that compile/run the JavaSE demos, compile Android guide sources, and validate generated screenshots.
Validation
python3 scripts/developer-guide/validate-guide-snippets.pyscripts/developer-guide/compile-android-demo-sources.shmvn -B -ntp -Dgenerate-gui-sources-done=true -Dcodename1.platform=javase -f docs/demos/pom.xml testgit diff --checkEarlier local validation also covered:
asciidoctor --failure-level WARN --verbose --trace -D build/developer-guide/local-html -o developer-guide.html docs/developer-guide/developer-guide.asciidocasciidoctor-pdf --trace -D build/developer-guide/local-pdf -o developer-guide.pdf docs/developer-guide/developer-guide.asciidocscripts/developer-guide/compare-guide-screenshots.sh build/developer-guide/guide-screenshots-local