feat: orchestration support

.github/workflows/check-python.yaml

@@ -14,7 +14,8 @@ jobs:
         run: pipx install poetry
 
       - name: Install algokit
-        run: pipx install algokit
+        # TODO: restore to algokit prior to release
+        run: pipx install git+https://github.com/algorandfoundation/algokit-cli@feat/orchestration-linking
 
       - name: Set up Python 3.12
         uses: actions/setup-python@v5

copier.yaml

@@ -1,23 +1,18 @@
 _subdirectory: template_content
 _templates_suffix: ".jinja"
 
+use_workspace:
+  type: bool
+  when: false # never prompted to user explicitly, instead expect cli to auto fill (supported cli versions > v1.13.x)
+  help: Automatically filled by AlgoKit CLI (>1.13.x) - passes the --workspace/--no-workspace flag's value, can be used to reason whether this template is currently being instantiated as part of a workspace or not.
+  default: no
+
 # questions
-# project_name should never get prompted, AlgoKit should always pass it by convention
 project_name:
   type: str
   help: Name for this project.
   placeholder: "algorand-app"
 
-contract_name:
-  type: str
-  help: Name of the default smart contract app.
-  placeholder: "hello_world"
-  default: "hello_world"
-  validator: >-
-    {% if not (contract_name | regex_search('^[a-z]+(?:_[a-z]+)*$')) %}
-    contract_name must be formatted in snake case.
-    {% endif %}
-
 author_name:
   type: str
   help: Package author name
@@ -30,6 +25,16 @@ author_email:
   placeholder: "[email protected]"
   default: "[email protected]"
 
+contract_name:
+  type: str
+  help: Name of the default smart contract app.
+  placeholder: "hello_world"
+  default: "hello_world"
+  validator: >-
+    {% if not (contract_name | regex_search('^[a-z]+(?:_[a-z]+)*$')) %}
+    contract_name must be formatted in snake case.
+    {% endif %}
+
 preset_name:
   type: str
   help: Name of the template preset to use.
@@ -57,7 +62,7 @@ ide_jetbrains:
   type: bool
   help: Do you want to add JetBrains configuration (primarily optimized for PyCharm CE)?
   when: "{{ preset_name == 'custom' }}"
-  default: no
+  default: "{{ 'yes' if preset_name == 'production' else 'no' }}"
 
 use_python_pytest:
   type: bool
@@ -79,40 +84,40 @@ python_linter:
     Ruff: "ruff"
     Flake8: "flake8"
     No thanks: "none"
-  default: "ruff"
+  default: "{{ 'ruff' if preset_name == 'production' else 'none' }}"
 
 use_python_black:
   type: bool
   help: Do you want to use a Python formatter (via Black)?
   when: "{{ preset_name == 'custom' }}"
-  default: yes
+  default: "{{ 'yes' if preset_name == 'production' else 'no' }}"
 
 use_python_mypy:
   type: bool
   when: "{{ preset_name == 'custom' }}"
   help: Do you want to use a Python type checker (via mypy)?
-  default: yes
+  default: "{{ 'yes' if preset_name == 'production' else 'no' }}"
 
 use_python_pip_audit:
   type: bool
   when: "{{ preset_name == 'custom' }}"
   help: Do you want to include Python dependency vulnerability scanning (via pip-audit)?
-  default: yes
+  default: "{{ 'yes' if preset_name == 'production' else 'no' }}"
 
 use_github_actions:
   type: bool
   when: "{{ preset_name == 'custom' }}"
   help: Do you want to include Github Actions workflows for build and testnet deployment?
-  default: yes
+  default: "{{ 'yes' if preset_name == 'production' else 'no' }}"
 
 use_pre_commit:
   type: bool
   when: "{{ preset_name == 'custom' }}"
   help: Do you want to include pre-commit for linting, type checking and formatting?
-  default: yes
+  default: "{{ 'yes' if preset_name == 'production' else 'no' }}"
 
 use_dispenser:
   type: bool
   when: "{{ preset_name == 'custom' }}"
   help: Do you want to fund your deployment account using an optional dispenser account?
-  default: no
+  default: "{{ 'yes' if preset_name == 'production' else 'no' }}"

examples/generators/production_puya_smart_contract_python/.algokit.toml

@@ -1,19 +1,49 @@
 [algokit]
-min_version = "v1.8.0"
+min_version = "v1.12.1"
 
-[deploy]
+[generate.smart_contract]
+description = "Adds new smart contract to existing project"
+path = ".algokit/generators/create_contract"
+
+[project]
+type = 'contract'
+name = 'production_puya_smart_contract_python'
+artifacts = 'smart_contracts/artifacts'
+
+[project.deploy]
 command = "poetry run python -m smart_contracts deploy"
 environment_secrets = [
   "DEPLOYER_MNEMONIC",
+  "DISPENSER_MNEMONIC",
 ]
 
-[deploy.localnet]
+[project.deploy.localnet]
 environment_secrets = []
 
-[generate.smart_contract]
-description = "Adds new smart contract to existing project"
-path = ".algokit/generators/create_contract"
+[project.run]
+# Commands intented for use locally and in CI
+build = { commands = [
+  'poetry run python -m smart_contracts build',
+], description = 'Build all smart contracts in the project' }
+test = { commands = [
+  'poetry run pytest',
+], description = 'Run smart contract tests' }
+audit = { commands = [
+  'poetry export --without=dev -o requirements.txt',
+  'poetry run pip-audit -r requirements.txt',
+], description = 'Audit with pip-audit' }
+lint = { commands = [
+  'poetry run black --check .',
+  'poetry run ruff .',
+  'poetry run mypy',
+], description = 'Perform linting' }
+audit-teal = { commands = [
+  # 🚨 IMPORTANT 🚨: For strict TEAL validation, remove --exclude statements. The default starter contract is not for production. Ensure thorough testing and adherence to best practices in smart contract development. This is not a replacement for a professional audit.
+  'algokit task analyze smart_contracts/artifacts --recursive --force --exclude rekey-to --exclude is-updatable --exclude missing-fee-check --exclude is-deletable --exclude can-close-asset --exclude can-close-account --exclude unprotected-deletable --exclude unprotected-updatable',
+], description = 'Audit TEAL files' }
 
-[project]
-type = 'contract'
-name = 'production_puya_smart_contract_python'
+# Commands indented for CI only, prefixed with `ci-` by convention
+ci-teal-diff = { commands = [
+  'git add -N ./smart_contracts/artifacts',
+  'git diff --exit-code --minimal ./smart_contracts/artifacts',
+], description = 'Check TEAL files for differences' }

examples/generators/production_puya_smart_contract_python/.github/workflows/production-puya-smart-contract-python-cd.yaml

@@ -0,0 +1,48 @@
+name: Release production_puya_smart_contract_python
+
+on:
+  workflow_call:
+  push:
+    branches:
+      - main
+
+jobs:
+  validate:
+    name: Validate production_puya_smart_contract_python
+    uses: ./.github/workflows/production-puya-smart-contract-python-ci.yaml
+  deploy-testnet:
+    runs-on: "ubuntu-latest"
+    needs: validate
+    environment: contract-testnet
+    steps:
+      - name: Checkout source code
+        uses: actions/checkout@v4
+
+      - name: Install poetry
+        run: pipx install poetry
+
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: "poetry"
+
+      - name: Install algokit
+        run: pipx install git+https://github.com/algorandfoundation/algokit-cli@feat/orchestration-linking
+
+      - name: Bootstrap dependencies
+        run: algokit bootstrap all --project-name 'production_puya_smart_contract_python'
+
+      - name: Configure git
+        shell: bash
+        run: |
+          # set git user and email as test invoke git
+          git config --global user.email "[email protected]" && git config --global user.name "github-actions"
+
+      - name: Deploy to testnet
+        run: algokit deploy testnet --project-name 'production_puya_smart_contract_python'
+        env:
+          # This is the account that becomes the creator of the contract
+          DEPLOYER_MNEMONIC: ${{ secrets.DEPLOYER_MNEMONIC }}
+          # The dispenser account is used to ensure the deployer account is funded
+          DISPENSER_MNEMONIC: ${{ secrets.DISPENSER_MNEMONIC }}