Skip to content

Support for zarf package reports/documentation #4346

@chaospuppy

Description

@chaospuppy

Is your feature request related to a problem? Please describe.

Currently, there is no standardized method for retrieving release notes, readmes, and other documents associated with a package other than tracing that package back to its source repository to view those documents. This feature request would add the ability to package creators to attach additional documentation to packages, which would then be carried with the package through to the destination environment.

This would assist with the following two Zarf user personas (at a minimum)

  1. Developers working in airgapped environments looking to gain additional context on packages without needing to leave that environment for an internet connection
  2. non-technical external registry users, such as UDS Registry users, could view documentation in a more user friendly manner

Describe the behavior you'd like

During Package Creation

  • Given a repository with a zarf.yaml, a readme/release notes/some other documentation
  • When a package developer runs zarf package create [--some-new-flag]
  • Then the package is created and documentation is embedded in the produced package. The location of the documentation within an OCI artifact is parsable from package metadata.

During Package Usage

  • Given an operator receives a Zarf package
  • When a package developer runs zarf package inspect *reports* *release-notes*
  • Then the requested documentation is retrieved from the package and displayed

Describe alternatives you've considered

(optional) A clear and concise description of any alternative solutions or features you've considered.

Additional context

Add any other context or screenshots about the feature request here.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    Status

    Done

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions