feat(experimental): Customizations files - #574
Open
adamspofford-dfinity wants to merge 8 commits into
Open
adamspofford-dfinity wants to merge 8 commits into
adamspofford-dfinity wants to merge 8 commits into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds support for project-level customization prompts driven by an icp_customize.yaml file, and ensures this customization manifest is preserved when projects are bundled so deployments can keep the same interactive customization behavior.
Changes:
- Introduces
operations::customizeto loadicp_customize.yaml, prompt for values, and substitute them into Candid init args. - Updates
deployto apply customization-derived init args with defined precedence relative to CLI--args/--args-fileand manifestinit_args. - Updates
bundleto includeicp_customize.yamlat the archive root and adds a regression test for this behavior.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| crates/icp-cli/tests/bundle_tests.rs | Adds test asserting icp_customize.yaml is bundled verbatim at archive root. |
| crates/icp-cli/src/operations/mod.rs | Registers the new customize operations module. |
| crates/icp-cli/src/operations/customize.rs | Implements customize manifest parsing, interactive prompting, and init-args field substitution with unit tests. |
| crates/icp-cli/src/operations/bundle.rs | Reads and appends icp_customize.yaml into the bundle archive and adds an error variant. |
| crates/icp-cli/src/commands/deploy.rs | Collects customization overrides pre-build and applies them between CLI args and manifest init args. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
adamspofford-dfinity
force-pushed
the
spofford/app-bundle-customize
branch
from
August 31, 2026 18:06
177d6de to
4c252f8
Compare
…ustomize main moved the operations into `crates/icp`, where nothing may touch the terminal, so the customize module splits along that line: the file, the substitution and the plan of what to ask stay in the operation, as `icp::operations::customize`, while `icp deploy` asks the questions and hands the answers to the deploy through `DeployParams`.
adamspofford-dfinity
marked this pull request as ready for review
September 18, 2026 21:47
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.
A project can ship an
icp_customize.yamlnext to its manifest declaring what whoever deploys it should be asked for, andicp deploy --customizeasks every question up front and then installs with the answers. An option either substitutes a Candid value into a field of the canister'sinit_args— addressed by arg index and field path, asked for at the declared type — or sets one of its environment variables, which needs no placeholder in the manifest. Options name canisters by store key, so a workspace declares its customizations once in the root project's file and can still reach a member's canister, and one option may name several canisters to be asked once and answered for all of them.icp project bundlepackages the file and validates its references, so a bundled app prompts the same way wherever it is extracted. Without the flag the file is inert;--args/--args-filestill outrank it, and init-arg options are skipped when they are given. The flag is hidden while the format settles.🤖 Generated with Claude Code