Open
Description
Creating a new repo tasks
-
- Create an issue for adding the new repo to the
nightly
branch.
It should contain the contents of this checklist as well as the contents of the
New Image Release checklist.
- Create an issue for adding the new repo to the
-
- Create a PR to add new repo and images to the
nightly
branch.
Follow the New Image Release
checklist. The PR must include:
-
- Unit tests.
-
- Scenario tests.
-
- README content. This content will show up on
GitHub (example),
MAR, (example), and
DockerHub (example).
It should contain:- An "About" section explaining what the image is and why it's useful.
- A "Usage" section explaining the very basics for getting started with the image.
- Links to official documentation and examples.
- Links to official support policy.
- README content. This content will show up on
- Create a PR to add new repo and images to the
-
- Create a PR to add the new repo to the MCR repo. https://github.com/microsoft/mcr/pull/3796
-
- Merge the PR to the nightly branch
-
- Create an issue for moving the new repo from the
nightly
tomain
branch according to
the guidelines that were decided on above.
- Create an issue for moving the new repo from the
Nightly Branch Tasks
-
- Update Dockerfiles and manifests
-
- Create Dockerfiles under
/src/$product/$major-minor-version/$os/$arch/
. These Dockerfiles can contain placeholder
content, as they will be re-generated by templates later.
- Create Dockerfiles under
-
- If necessary, create new templates for Dockerfiles
and Readmes- See CONTRIBUTING.md
for instructions on editing templates.
- See CONTRIBUTING.md
- If necessary, create new templates for Dockerfiles
-
- Update the MAR tags metadata templates
to include the new images
- Update the MAR tags metadata templates
-
- Update manifest.json
to reference the new set of Dockerfiles and templates with the appropriate tags.- See the supported tags policy
to see which tagging patterns to follow.
- See the supported tags policy
- Update manifest.json
-
- Run the commands to generate the Dockerfiles and READMEs based on templates:
-
-
pwsh .\eng\readme-templates\Get-GeneratedDockerfiles.ps1
-
-
-
pwsh .\eng\readme-templates\Get-GeneratedReadmes.ps1
-
-
- Inspect generated changes for correctness
-
- Update tests
-
- Add new image to
TestData.cs
- Add new image to
-
- Add unit tests and scenario tests. Follow existing patterns for other images.
-
- Consider authoring sample Dockerfiles and adding them to samples
-
- If not adding sample Dockerfiles, provide justification: samples will live in the reverse-proxy and aspire repo
-
- Run
build-and-test.ps1
to build and test your images- See CONTRIBUTING.md for more detailed instructions
- Run
-
- Commit changes
-
- Create PR
-
- Consider drafting an announcement to be posted on this repo's discussions page
when images are published
- Consider drafting an announcement to be posted on this repo's discussions page
-
- Get PR signoff
-
- Merge PR to nightly branch
-
- Wait for automatically queued CI build to finish on dotnet-docker-nightly pipeline (internal MSFT link)
-
- Confirm READMEs have been updated on MAR and Docker Hub
Metadata
Metadata
Assignees
Type
Projects
Status
In Progress