Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 0 additions & 76 deletions .github/ISSUE_TEMPLATE/badge_status.md

This file was deleted.

2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ Other:
### Severity/Priority

### Additional Context
Add any other context or screenshots about the technical debt here.
Add any other context or screenshots about the bug here.
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ Relates to #
## Checklist before merging

- [ ] Test, docs, adr added or updated as needed
- [ ] [Contributor Guide Steps](https://github.com/uds-packages/#TEMPLATE_APPLICATION_NAME#/blob/main/CONTRIBUTING.md#developer-workflow) followed
- [ ] [Contributor Guide Steps](https://github.com/uds-packages/#TEMPLATE_APPLICATION_NAME#/blob/main/CONTRIBUTING.md) followed
1 change: 1 addition & 0 deletions .github/workflows/auto-update.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ on:
permissions:
contents: write # Allows writing content to the repository.
packages: read # Allows reading the content of the repository's packages.
pull-requests: write # Allows creating or updating pull requests.

# Abort prior jobs in the same workflow / PR
concurrency:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:
id-token: write
strategy:
matrix:
flavor: [upstream, registry1, unicorn]
flavor: [upstream]
architecture: [amd64, arm64]
exclude:
- flavor: registry1
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ jobs:
fail-fast: false
matrix:
type: [install, upgrade]
flavor: [upstream, unicorn, registry1]
flavor: [upstream]
uses: defenseunicorns/uds-common/.github/workflows/callable-test.yaml@1614a9f51fbf1f21e7a28020702773d9bdefd8fe # v1.24.5
with:
timeout: 30
Expand Down
37 changes: 16 additions & 21 deletions CODEOWNERS-template.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,32 @@
The current `CODEOWNERS` file that exists, is to denote who owns this `uds-package-template`. If you are creating a new package from this template, you can copy / paste one of the below examples into the `CODEOWNERS` file, then modify the string to fit your needs. After updating the `CODEOWNERS` file to your liking, you can delete this file.
# Configuring CODEOWNERS for your package

The `CODEOWNERS` file should follow the below format, you can even just copy / paste the exact text into the `CODEOWNERS` file.
The `CODEOWNERS` file in this repo denotes who owns the template itself. When creating a new package, replace its contents with one of the patterns below, then delete this file.

```
* @uds-packages/uds-foundry
# * @additional-team - as appropriate

/CODEOWNERS @jeff-mccoy @daveworth
/LICENS* @jeff-mccoy @austenbryan
```
> [!IMPORTANT]
> Use GitHub team handles (e.g., `@uds-packages/uds-foundry`), not individual user handles. Teams stay current as people join and leave; pinning to individuals leaves reviews orphaned and creates approval bottlenecks.

If you would like to add optional package reviewers, such as the creator of the app, you can append creators after `uds-foundry`

For instance, you could handle this like below:
## Standard pattern

```
* @defenseunicorns/uds-foundry @name-of-creator/s @name-of-established-known-team
* @uds-packages/uds-foundry @creator-team

/CODEOWNERS @jeff-mccoy @daveworth
/CODEOWNERS @jeff-mccoy @daveworth
/LICENS* @jeff-mccoy @austenbryan
```

Keeping the reviewers on one line, like the above format, makes it easier on Bullpen to approve Support / Maintenance PRs on a package.
This format with everything on one line, enables an `OR` for package approvers. So, `uds-foundry` OR `@name-of-creator/s` could approve a PR.
This combines `uds-foundry` with the package's creator team on a single line — either team can approve a PR (OR semantics). Replace `@creator-team` with the GitHub team handle for the group that built the package.

The `/CODEOWNERS` and `/LICENS*` lines pin those files to Defense Unicorns release engineering — keep them as-is.

## Requiring approval from every group (AND)

If you break the lines up like the below, then it becomes an `AND`. So, it would take both `uds-foundry` AND `@name-or-creator/s` to approve a PR.
If every team must weigh in before a PR can merge, put each owner on its own `*` line.

```
* @defenseunicorns/uds-foundry
* @name-of-creator/s #optional during package creation to enable velocity
* @name-of-established-known-team #optional addition to "uds-foundry"
* @uds-packages/uds-foundry
* @creator-team
* @other-team

/CODEOWNERS @jeff-mccoy @daveworth
/CODEOWNERS @jeff-mccoy @daveworth
/LICENS* @jeff-mccoy @austenbryan
```
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

Thank you for your interest in this Defense Unicorns UDS Package!

This package is part of Defense Unicorns' Unicorn Delivery Service and follows the contributing guidelines outlined in that repositories' [CONTRIBUTING.md](https://github.com/defenseunicorns/uds-common/blob/main/CONTRIBUTING.md) file.
This package is part of Defense Unicorns' Unicorn Delivery Service and follows the contributing guidelines outlined in [uds-common's CONTRIBUTING.md](https://github.com/defenseunicorns/uds-common/blob/main/CONTRIBUTING.md).
33 changes: 14 additions & 19 deletions README-template.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,31 @@
# UDS Package #TEMPLATE_APPLICATION_DISPLAY_NAME#

This package is designed to be deployed on [UDS Core](https://github.com/defenseunicorns/uds-core) and is based on the upstream [#TEMPLATE_APPLICATION_DISPLAY_NAME#](#TEMPLATE_CHART_REPO#) chart.
This package deploys [#TEMPLATE_APPLICATION_DISPLAY_NAME#](#TEMPLATE_CHART_REPO#) on [UDS Core](https://github.com/defenseunicorns/uds-core).

> INSERT HERE 1-2 sentence summary of what the application does.
> 1-2 sentence summary of what the application does.

## Pre-requisites
## Prerequisites

The #TEMPLATE_APPLICATION_DISPLAY_NAME# Package expects to be deployed on top of [UDS Core](https://github.com/defenseunicorns/uds-core) with the dependencies listed below being configured prior to deployment.

#### Dependency information

Add any dependency information here
This package expects to be deployed on top of [UDS Core](https://github.com/defenseunicorns/uds-core). Document any additional dependencies (databases, operators, etc.) here.

## Flavors

| Flavor | Description | Example Creation |
| ------ | ----------- | ---------------- |
| `upstream` | Uses upstream images within the package. | `zarf package create . -f upstream` |
| `registry1` | Uses images from registry1.dso.mil within the package | `zarf package create . -f registry1` |
| `unicorn` | Uses images from rapidfort within the package | `zarf package create . -f unicorn` |
This package ships an `upstream` flavor by default. Add `registry1` or `unicorn` flavors as needed — see [`zarf.yaml`](./zarf.yaml).

## Releases

The released packages can be found in [ghcr](https://github.com/uds-packages/#TEMPLATE_APPLICATION_NAME#/pkgs/container/#TEMPLATE_APPLICATION_NAME#).
Released packages are available in [GHCR](https://github.com/uds-packages/#TEMPLATE_APPLICATION_NAME#/pkgs/container/#TEMPLATE_APPLICATION_NAME#).

## UDS Tasks (for local dev and CI)
## Local development

*For local dev, this requires you install [uds-cli](https://github.com/defenseunicorns/uds-cli?tab=readme-ov-file#install)
Requires the [UDS CLI](https://github.com/defenseunicorns/uds-cli?tab=readme-ov-file#install).

> [!TIP]
> To get a list of tasks to run you can use `uds run --list`!
```bash
uds run default # spin up a local k3d cluster, build, and deploy
uds run dev # iterate on an existing cluster
uds run --list # show all available tasks
```

## Contributing

Please see the [CONTRIBUTING.md](./CONTRIBUTING.md)
See [CONTRIBUTING.md](./CONTRIBUTING.md).
Loading
Loading