Add multilang examples and CI check; expand README (CI/CD, preview) - #8
Merged
Conversation
- Add sample projects: ts-app, python-app, java-app, go-app, rust-app - Add scripts/generate-examples.ts to produce examples/*.md from source - CI: verify examples/*.md are up-to-date after generate:examples - README: add CI/CD & Automation section, --generated-date option, link previews to examples - Move generate-version.ts to scripts/generate-version.ts
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
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.
Description
Closes #6
What does this PR do?
Adds minimal sample projects in TypeScript, Python, Java, Go, and Rust under
examples/, each with a generatedflnsnapshot (examples/*.md), and ensures those snapshots stay in sync in CI. Expands the README with a language-agnostic pitch, a CI/CD & Automation section (GitHub Actions snapshot workflow, pre-commit context guard), and a Preview section that links to the real example outputs instead of inline placeholders.Changes
examples/with ts-app, python-app, java-app, go-app, rust-app (source + generated*.mdsnapshots)scripts/generate-examples.tsandbun run generate:examplesto regenerateexamples/*.mdgit diff --exit-code -- "examples/*.md")examples/*.mdexamples/README.mddescribing the layout and regenerationTesting
bun testpassesbun run lintpassesbun run typecheckpassesChecklist