dotnet / dotnet/docker-tools

Document known edge cases for infrastructure operating on Manifest and ImageArtifactDetails

Open
#1,495 2 comments 0 reactions 0 assignees View on GitHub
area-infrastructure
Dominant language
C#
Stars
181
Forks
67
Avg merge
2d 15h
Merged PRs (30d)
10

Description

Context: https://github.com/dotnet/docker-tools/issues/1493#issuecomment-2468542699

We should have some infrastructure or documentation that details the common edge cases that new ImageBuilder features need to test against. Some examples include:

1. Adding images
2. Removing images
3. Adding tags
4. Removing tags
5. All images cached
6. No images cached
7. Retry when the command failed
8. Retry when a previous pipeline step failed
9. Retry when a subsequent pipeline step failed (meaning - commands should be idempotent)
10. ImageInfo is updated mid-publish
11. Partial version update (e.g. SDK-only release)

This documentation should guide future implementation of tests. For the next feature we implement, we may find it useful to add some common definitions of test data for these scenarios.

Documentation should go in [`README.md`](https://github.com/dotnet/docker-tools/blob/main/README.md), [`src/Microsoft.DotNet.ImageBuilder/README.md`](https://github.com/dotnet/docker-tools/blob/main/src/Microsoft.DotNet.ImageBuilder/README.md), or a new `CONTRIBUTING.md` file.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.