Remove ambiguous 'environment' metadata attribute#143
Merged
Conversation
Removed the 'environment' field from submission metadata due to: - Low adoption (28.6% of submissions) - Inconsistent semantics across compilers - Not used by any tooling or validation logic - Ambiguous purpose (compiler deps vs runtime deps) Changes: - Schema: Removed environment property from metadata.schema.json - Documentation: Updated README, submission-guide, domain-model - Submissions: Removed environment from 9 existing submissions - 4 Plinth submissions (plutus-tx/core/ledger-api dependencies) - 2 OpShin submissions (uplc library dependency) - 3 Aiken submissions (empty dependencies) - All submissions verified and tests passing The field was optional and can be re-introduced later if a clear use case emerges with proper semantics. Fixes #142
Contributor
🚀 PR Preview DeployedPreview URL: https://intersectmbo.github.io/UPLC-CAPE/pr-143/ The preview site is automatically updated on every push to this PR and will be removed when the PR is closed. |
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.
Summary
Removes the
environmentfield from submission metadata as it has proven to be ambiguous and not useful to authors.Problem
The
environmentmetadata attribute suffered from several issues:"dependencies": {})Changes
Schema Changes (2 files)
submissions/TEMPLATE/metadata.schema.json- Removed environment property definitionsubmissions/TEMPLATE/schemas-README.md- Removed environment documentationSubmission Data (9 files)
Removed
environmentobject from:Documentation (3 files)
README.md- Removed environment from metadata example and reproducibility notesdoc/submission-guide.md- Removed environment from metadata exampledoc/domain-model.md- Removed environment references from domain modelImpact
Validation
cape submission verifycabal testtreefmtFixes #142