Docs: Add Docker workflows design brief - #6
Merged
askb merged 1 commit intoJul 31, 2026
Conversation
Copilot started reviewing on behalf of
ModeSevenIndustrialSolutions
July 31, 2026 10:24
View session
There was a problem hiding this comment.
Pull request overview
Updates docs/BRIEF.md to replace the template placeholder with a detailed design brief / gap analysis that will guide the upcoming implementation of reusable Docker build/publish workflows (including ONAP-specific constraints and rollout sequencing).
Changes:
- Replaces the generic
workflows-templatebrief with a Docker workflows gap-analysis brief (ONAP census, conventions, layouts, and priority order). - Documents proposed workflow lanes (verify / Model A / Model B), input surface, reuse vs build decisions, and action/fixture gaps.
- Adds rollout plan and open questions to drive subsequent implementation rounds.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Replace the workflows-template placeholder brief with the gap analysis for the Docker build/publish workflows (tracking issue lfreleng-actions/.github#142). The brief captures: the ONAP Docker landscape census (306 Dockerfiles across 99 repos; fabric8 docker-maven-plugin dominant in 63), versioning/tagging conventions (version.properties, STAGING tag idiom, releases/*-container.yaml self-release files), registry topology (Nexus3 ports 10001-10004, docker.io, ghcr.io), the repository layouts the workflows must handle (monorepos, base-image chains, artifact-first builds, multi-arch), a priority order from the release-mapping tool (57 repos shipping 88 in-release images), reuse of the existing action estate and third-party Docker actions, the proposed workflow/input surface, gaps requiring new actions (docker-build-matrix-action, docker-promote-action), and a rollout plan piloting on sdc/sdc-docker-base. The document is a design-decisions record with special status; it is exempt from the write-good prose linter (template convention). Co-authored-by: Claude <noreply@anthropic.com> Signed-off-by: Matthew Watkins <mwatkins@linuxfoundation.org>
ModeSevenIndustrialSolutions
force-pushed
the
docs/design-brief
branch
from
July 31, 2026 10:48
81cd624 to
5779f73
Compare
Copilot started reviewing on behalf of
ModeSevenIndustrialSolutions
July 31, 2026 10:49
View session
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
Suppressed comments (1)
docs/BRIEF.md:130
- This paragraph asserts the registry endpoints are already in the org harden-runner allow-list at “v0.12.1”, but the workflows in this repo currently default
harden_runner_allowlistto a v0.4.1 pin. To avoid misleading readers, either align the version reference with the workflow default, or rephrase as a requirement (and note the pin to bump when enabling block mode).
All of these endpoints (Docker Hub auth/registry/CDN hosts, `ghcr.io`,
`hub.docker.com`, `nexus3.onap.org:10001-10004`) are **already in the
org harden-runner `allow_list.txt` (v0.12.1)**. Base images pulled
from arbitrary third-party registries are the un-enumerable case —
askb
approved these changes
Jul 31, 2026
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
Suppressed comments (1)
docs/BRIEF.md:132
- This paragraph cites org harden-runner
allow_list.txtv0.12.1, but this repository’s workflow defaults currently pin the allow-list at v0.4.1 (e.g..github/workflows/build-test.yaml). As written, the doc can mislead readers into assuming the pinned allow-list already includes these endpoints; either align the version reference with the pinned default or call out that the pin must be bumped.
All of these endpoints (Docker Hub auth/registry/CDN hosts, `ghcr.io`,
`hub.docker.com`, `nexus3.onap.org:10001-10004`) are **already in the
org harden-runner `allow_list.txt` (v0.12.1)**. Base images pulled
from arbitrary third-party registries are the un-enumerable case —
exactly what the `build_permit_egress_traffic` hatch (already in the
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.
Docs: Add Docker workflows design brief
Replaces the
workflows-templateplaceholder brief with the research/gap-analysis brief for the Docker build/publish workflows.Tracking issue: lfreleng-actions/.github#142
Contents
version.properties(110 repos), SNAPSHOT/STAGING tag idioms,releases/*-container.yamlself-release files (1,286 across the estate), Nexus3 registry port topologysdc/sdc-docker-baseas pilot)build-test/mergeModel B /build-test-releaseModel A), input surface, new actions needed (docker-build-matrix-action,docker-promote-action), fixture gapsLinting
markdown-table-fixer;markdownlintpassesdocs/BRIEF.mdretains the template's existingwrite-goodexemption (design-decisions record, not polished prose)The brief is the input for the subsequent agentic development rounds that will implement the workflows and supporting actions.