-
Notifications
You must be signed in to change notification settings - Fork 46
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
feat: init wizard v2 #415
feat: init wizard v2 #415
Conversation
@@ -61,14 +81,17 @@ def _get_blessed_templates() -> dict[str, BlessedTemplateSource]: | |||
"puya": BlessedTemplateSource( | |||
url="gh:algorandfoundation/algokit-puya-template", | |||
description="Official starter template for Puya applications (Dev Preview, not recommended for production)", | |||
branch="poc/wizard_v2", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@robdmoore @neilcampbell please note this is a temporary change done for the sake of adr given that dependant templates also rely on changes on specific branch
@robdmoore @neilcampbell still keeping the pr in draft for ~1 more day until related prs on templates are opened too, added extra tests here and minor tweaks but should mostly be ready for review already |
@neilcampbell @robdmoore added extra logic as per latest discussions, adds optional behaviour that transforms any standalone template into a workspace structure by default OR if its already init'd from root of a workspace project it will auto inject the standalone template under expected folder. Let me know what you think, ignore the tests for now - will patch on monday |
@robdmoore @neilcampbell added extra documentation and usage of https://github.com/algorandfoundation/algokit-base-template to enforce workspace structure by default. This base is reused within all official templates (including fullstack) and decouple files that we want to see in the base structure from individual templates. The best way to get a hang of the latest state is to checkout the branch and interact with the new wizard within poetry shell. Would appreciate initial round of reviews as there are still certain open questions:
cc @PhearZero @joe-p @CiottiGiorgio @iskysun96 - feel free to try it out as well if you want to provide preliminary feedback, please note the branch might still have further commits AFTER we coordinate opening prs on templates. Template prs will be merged first then we will make the prerelease on the cli and will coordinate with @Loedn to have an interactive feedback session to patch any last minute tweaks before end of month. Otherwise if all good i'll jump to part 2 (which will add orchestration on top of whats enforced with the new features in this pr) |
|
@neilcampbell all templates should be up to date with latest - so running algokit cli from this branch should not have any e2e problems (only tested on windows so far though, but binaries portability tests add a bit more confidence). A PR for fullstack is available here algorandfoundation/algokit-fullstack-template#19, once base template is public i'll open prs on remaining repos (no reason to open now since all will fail due to base being private repo) will resolve your comments a bit later (some of those are already addressed, just didn't have time to resolve individually yet) |
@robdmoore thanks for reporting on the bugs so far - they are fixed now, let me know if there are any further comments. Also refer to updated pr description that includes refs to prs on respective react, fullstack, beaker and puya templates |
Co-authored-by: Neil Campbell <[email protected]>
@joe-p @PhearZero just fyi, as agreed i updated child templates to come shipped with type As for this pr and all prs on templates, we will coordinate a release on monday with @neilcampbell and @Loedn |
Implements https://github.com/orgs/algorandfoundation/projects/1?pane=issue&itemId=53079977
Proposed Changes
This is a draft moving the PoC for init wizard v2 discussed in #411.
The adr is split into 2 parts and this PR will be covering the improvements in wizard v2 + changes in related template repos.
Currently the draft contains poc code shown during the init wizard v2 discussions for the ADR. The PR is to be refined and turned into a full implementation by the time it leaves the draft state.
To interact with the PoC simply checkout the branch and access algokit inside poetry environment. Please note that
tealscript
template variation is not yet fully covered as poc was demoing a happy path from start to fullstack with puya + react components (this is to be patched soon).Template PRs
Above has to be merged first -> branch refs has to be then removed on this PR, afterwards ready to release new cli version