Skip to content

Commit

Permalink
add metadata guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewg-xyz committed Oct 7, 2024
1 parent cab7483 commit 1678313
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
7 changes: 7 additions & 0 deletions docs/uds-packages/metadata/airgap-app-store.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Application Metadata

When a uds-package [achieves a badge](../requirements/uds-package-requirements.md), it is eligible for inclusion and publishing on the Airgap App Store [apps.uds.is](https://apps.uds.is). _(soon apps.defenseunicorns.com [#170](https://github.com/defenseunicorns/uds-marketplace/issues/170))_

Packages listed on the App Store include some metadata describing the package. [zarf-dev/zarf#2976](https://github.com/zarf-dev/zarf/issues/2976) introduces annotations, which will be leveraged to provide this metadata. Until released, the metadata will be stored in a separate file in the App Store repository.

Instructions on creating Application Metadata can be found in [uds-appstore Contributing Guide](https://github.com/defenseunicorns/uds-appstore/blob/main/CONTRIBUTING.md#app-store-package-metadata)
2 changes: 1 addition & 1 deletion docs/uds-packages/requirements/uds-package-requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Bronze packages:
- **Must** release its package to the `ghcr.io/defenseunicorns/packages/<group>` namespace as the application's name (i.e. `ghcr.io/defenseunicorns/packages/uds/mattermost`).
- **Must** not make the assumption that the `expose` interfaces are accessible to the bastion or pipeline deploying the package (i.e. `*.uds.dev`).
> If web requests need to be made they should be done through a `Job` or `./uds zarf tools kubectl exec` as appropriate.
- **Must** include application metadata for Airgap App Store publishing
- **Must** include application [metadata for Airgap App Store](../metadata/airgap-app-store.md) publishing
- **Should** lint their configurations with appropriate tooling, such as [`yamllint`](https://github.com/adrienverge/yamllint) and [`zarf dev lint`](https://docs.zarf.dev/commands/zarf_dev_lint/).

## Badging
Expand Down

0 comments on commit 1678313

Please sign in to comment.