Skip to content
This repository has been archived by the owner on Nov 27, 2024. It is now read-only.

chore: deprecate beaker template with explicit question + warning & exit task #77

Closed
wants to merge 2 commits into from

Conversation

aorumbayev
Copy link
Contributor

@aorumbayev aorumbayev commented Nov 22, 2024

Proposed Changes

Slightly different approach to deprecation warning on beaker template:

  • Reuses approach with custom tasks from fullstack template
    • A dedicated post_init.py script which takes care of deleting cloned template content (copier has limitation in regards to only running tasks after template is instantiated)
    • Covers edge cases when init is done in workspaces vs no workspace mode
    • Covers edge cases when init is run from algokit binary where we need to use pre bundled python instead given that a user may not have python installed

@aorumbayev aorumbayev requested a review from lempira November 22, 2024 06:07
@aorumbayev
Copy link
Contributor Author

aorumbayev commented Nov 22, 2024

@lempira i did a test on windows vm with a wheel based algokit, but would suggest doing an extra sanity check on algokit binary on windows/unix and wheel based algokit on windows. Windows is often full of surprises - although i don't anticipate any issues with this.

You can quickly test it with command below, an explicit question on whether to proceed with deprecated template or not will be asked to user before any other copier questions on the template. If user says NO (which is the default) -> post init script will revert everything and print instructions suggesting to use python template.
algokit -v init --template-url=https://github.com/algorandfoundation/algokit-beaker-default-template --template-url-ref=deprecate-template-v2

If you are ok with the approach, feel free to merge to your branch and then squash merge to main (ill pre approve your pr), also please add chore: to the merge commit message title to ensure semantic release is properly dumped on releases page on the repo.

@aorumbayev aorumbayev force-pushed the deprecate-template-v2 branch 2 times, most recently from 02f4f73 to 51b0834 Compare November 22, 2024 06:23
@lempira lempira force-pushed the deprecate-template branch 2 times, most recently from 0618237 to e9e7e37 Compare November 22, 2024 20:02
@aorumbayev aorumbayev force-pushed the deprecate-template-v2 branch 2 times, most recently from 5f9ac54 to 5a87d14 Compare November 24, 2024 19:31
@aorumbayev aorumbayev force-pushed the deprecate-template-v2 branch from 5a87d14 to daa11dc Compare November 25, 2024 05:08
@aorumbayev
Copy link
Contributor Author

@lempira i see you migrated some of the changes from this branch directly, so closing the pr

@aorumbayev aorumbayev closed this Nov 25, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants