Conversation
…ts. Updating tests to match structure. Moving examples from description to examples field for some fields.
|
The /docs still need updated to reflect the changes from this PR. |
There was a problem hiding this comment.
Pull request overview
This PR introduces a new parameters object to support environment variables and command-line arguments in challenge deployments, replacing the previous flagArg string field. The changes enable more flexible and explicit configuration of how dynamic flags and other parameters are passed to challenges.
Key Changes:
- Introduces a new
parametersobject structure containingargumentsandenvironmentVariablesarrays withflagArgumentNameandflagEnvironmentVariableNamefor referencing flag parameters - Updates schema files to use the new parameters object in both container and script deployment options
- Refactors description metadata to use separate
examplesfields for better schema documentation
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
src/challenge-schema/challengeDeployment/argsAndEnvs.ts |
New file defining the parameters schema with arguments, environment variables, and flag reference validation |
src/challenge-schema/challengeDeployment/scriptOptions.ts |
Replaces flagArg field with new parameters object |
src/challenge-schema/challengeDeployment/containerOptions.ts |
Replaces flagArg field with parameters object and moves examples from descriptions to examples field |
tests/examples/cookie-monster/challenge.json |
Updates test case to use new parameters structure with environment variables |
tests/examples/caesar-cipher/challenge.json |
Updates test case to use new parameters structure with command-line arguments |
tests/challenge-bundle.int.test.ts |
Minor test description update from "Challenge Bundle Schema Validation" to "Challenge Schema Validation" |
docs/mkdocs.yml |
Adds new navigation entry for parameters documentation |
docs/docs/examples/index.md |
Updates examples to demonstrate new parameters structure |
docs/docs/ChallengeSchema/ChallengeDeployment/standard-deployment.md |
Updates documentation examples and restructures required/optional fields table |
docs/docs/ChallengeSchema/ChallengeDeployment/parameters.md |
New comprehensive documentation for parameters, arguments, and environment variables |
docs/docs/ChallengeSchema/ChallengeDeployment/index.md |
Updates examples to use new parameters structure |
docs/docs/ChallengeSchema/ChallengeDeployment/hosted-deployment.md |
Updates hosted deployment example to use new parameters structure |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 12 out of 12 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…t and flagEnvironmentVariables at the same time.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 16 out of 16 changed files in this pull request and generated 10 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 16 out of 16 changed files in this pull request and generated no new comments.
Comments suppressed due to low confidence (1)
tests/bad-examples/missing-flag-options/bad-default-flag-type.json:4
- The word "Seasame" is misspelled. It should be "Sesame" (as in "Sesame Street").
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Adding parameters object to support environment variables and command line arguments.
Updating test files to match new structure.
Minor updates to some fields to move examples from description to examples field.