Skip to content

Add Reverse Proxy (YARP) repo to the nightly branch #6154

@benjaminpetit

Description

@benjaminpetit

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 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.
    • Merge the PR to the nightly branch
    • Create an issue for moving the new repo from the nightly to main branch according to
      the guidelines that were decided on above.

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.
      • Update manifest.json
        to reference the new set of Dockerfiles and templates with the appropriate tags.
      • 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 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
    • Commit changes
    • Create PR
    • Consider drafting an announcement to be posted on this repo's discussions page
      when images are published
    • Get PR signoff
    • Merge PR to nightly branch

Metadata

Metadata

Assignees

Projects

  • Status

    In Progress

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions