Submitting a New Release¶
1. Description¶
The release submission flow allows users to create a new version of an existing ingredient. This includes filling in metadata, uploading artifacts, defining dependencies, and optionally linking to a baseline release. The submission process is schema-driven and may vary slightly based on the ingredient type.
2. How to Start¶
You can submit a new release by:
-
Clicking “Create Release” from the Ingredient View
-
Accessing the submission flow from a workflow output step (build/test)
You must have edit permissions on the feed to initiate a submission.
3. Submission Steps (UI Flow)¶
Step | Description |
---|---|
Version & Release Note | Provide a unique version ID and a structured release note (rich text) |
Metadata Fields | Fill in schema-required fields (e.g., silicon, SKU, step, validation area) |
Artifacts Upload | Upload binaries, inc files, or metadata packages |
Dependencies | Add any required ingredient releases this one depends on |
Baseline (Optional) | Select a previous release to track changes from |
Review & Confirm | Summary view showing all entered info and validation results |
⚠️ Once submitted, a release becomes immutable. Only a new release can supersede or revise the current one.
4. Version Requirements¶
-
Must be unique within the ingredient
-
Supports free text (e.g.,
2024WW12.4
,v3.1.7
,drop_B0_patch3
) -
Used as the primary identifier in CLI, UI, and workflows
5. Artifact Uploads¶
-
Supported formats: binary files, zip archives, text config files
-
Files are stored in Azure Blob Storage under the corresponding feed
-
Large files (>2GB) may require CLI-based submission or direct upload integrations
6. Dependency Selection¶
-
You can add dependencies by:
- Selecting ingredient type → selecting ingredient → choosing version
-
Only released versions can be selected as dependencies
-
Circular dependencies are prevented automatically
7. Baseline Tracking¶
-
Selecting a baseline enables automated change summary generation
-
VDC will compare:
-
Metadata differences
-
Dependency diffs
-
Artifact name/size changes
-
8. Validation & Errors¶
During the Review & Confirm step:
-
The system validates:
-
Schema completeness
-
Version uniqueness
-
Dependency resolution
-
-
Blocking errors will prevent submission
-
Warnings will be shown but allow submission
9. After Submission¶
Once submitted:
-
Release becomes visible in the Ingredient View
-
Metadata and artifacts are locked
-
Used-By tracking and dependency resolution are updated
-
CI/CD or workflow tools can now consume the release