Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automate creation of READMEs and example creation scripts #27

Merged
merged 1 commit into from
Feb 11, 2025

Conversation

ianthomas23
Copy link
Member

Each example in this repo has both a README that is human-readable to manually create the example, and a create_* bash script to automatically create the example. Rather than keep these as two separate files which will diverge in time, here I am adding TypeScript code in the new recipes directory to create both files from a single source. Each example will have its own recipe (e.g. vanilla_webpack_recipe.ts) consisting of multiple steps, and the READMEs and scripts can be regenerated using

cd recipes
npm install
npm run build
npm run create

This can be run manually as required and the diffs inspected before committing.

@ianthomas23 ianthomas23 added the enhancement New feature or request label Feb 11, 2025
@ianthomas23 ianthomas23 merged commit 3ffbae1 into main Feb 11, 2025
2 checks passed
@ianthomas23 ianthomas23 deleted the create-recipes branch February 11, 2025 15:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant