forked from defenseunicorns/uds-identity-config
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit e24a266
Showing
52 changed files
with
6,897 additions
and
0 deletions.
There are no files selected for viewing
Empty file.
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
title: '' | ||
labels: possible-bug | ||
assignees: '' | ||
--- | ||
|
||
### Environment | ||
Device and OS: | ||
App version: | ||
Kubernetes distro being used: | ||
Other: | ||
|
||
### Steps to reproduce | ||
1. | ||
|
||
### Expected result | ||
|
||
### Actual Result | ||
|
||
### Visual Proof (screenshots, videos, text, etc) | ||
|
||
### Severity/Priority | ||
|
||
### Additional Context | ||
Add any other context or screenshots about the technical debt here. |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
title: '' | ||
labels: 'enhancement' | ||
assignees: '' | ||
--- | ||
|
||
### Is your feature request related to a problem? Please describe. | ||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
### Describe the solution you'd like | ||
|
||
- **Given** a state | ||
- **When** an action is taken | ||
- **Then** something happens | ||
|
||
### 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. |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
--- | ||
name: Tech debt | ||
about: Record something that should be investigated or refactored in the future. | ||
title: '' | ||
labels: 'tech-debt' | ||
assignees: '' | ||
--- | ||
|
||
### Describe what should be investigated or refactored | ||
A clear and concise description of what should be changed/researched. Ex. This piece of the code is not DRY enough [...] | ||
|
||
### Links to any relevant code | ||
(optional) i.e. - https://github.com/defenseunicorns/uds-template-capability/blob/main/README.md?plain=1#L1 | ||
|
||
### Additional context | ||
Add any other context or screenshots about the technical debt here. |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
## Description | ||
|
||
... | ||
|
||
## Related Issue | ||
|
||
Fixes # | ||
<!-- or --> | ||
Relates to # | ||
|
||
## Type of change | ||
|
||
- [ ] Bug fix (non-breaking change which fixes an issue) | ||
- [ ] New feature (non-breaking change which adds functionality) | ||
- [ ] Other (security config, docs update, etc) | ||
|
||
## Checklist before merging | ||
|
||
- [ ] Test, docs, adr added or updated as needed | ||
- [ ] [Contributor Guide Steps](https://github.com/defenseunicorns/uds-template-capability/blob/main/CONTRIBUTING.md)(https://github.com/defenseunicorns/uds-template-capability/blob/main/CONTRIBUTING.md#submitting-a-pull-request) followed |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
name: Metadata | ||
|
||
on: | ||
pull_request: | ||
branches: [main] | ||
types: [opened, edited, synchronize] | ||
|
||
jobs: | ||
title_check: | ||
runs-on: ubuntu-latest | ||
name: Validate PR Title | ||
permissions: | ||
pull-requests: read | ||
|
||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 | ||
with: | ||
fetch-depth: 0 | ||
|
||
- name: Setup Node.js | ||
uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2 | ||
|
||
- name: Install commitlint | ||
run: | | ||
npm install --save-dev @commitlint/[email protected] | ||
npm install --save-dev @commitlint/[email protected] | ||
- name: Lint PR title | ||
env: | ||
pull_request_title: ${{ github.event.pull_request.title }} | ||
run: echo "$pull_request_title" | npx commitlint |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
name: Publish | ||
|
||
on: | ||
push: | ||
branches: | ||
- main | ||
|
||
jobs: | ||
tag-new-version: | ||
name: Tag New Version | ||
permissions: write-all | ||
runs-on: ubuntu-latest | ||
outputs: | ||
release_created: ${{ steps.release-flag.outputs.release_created }} | ||
steps: | ||
- name: Create release tag | ||
id: tag | ||
uses: google-github-actions/release-please-action@cc61a07e2da466bebbc19b3a7dd01d6aecb20d1e # v4 | ||
with: | ||
command: manifest # use configs in release-please-config.json | ||
- id: release-flag | ||
run: echo "release_created=${{ steps.tag.outputs.release_created || false }}" >> $GITHUB_OUTPUT | ||
|
||
publish-uds-core: | ||
needs: tag-new-version | ||
if: ${{ needs.tag-new-version.outputs.release_created == 'true'}} | ||
runs-on: ubuntu-latest | ||
name: Publish Image | ||
|
||
permissions: | ||
contents: read | ||
packages: write | ||
|
||
steps: | ||
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 | ||
|
||
- name: Set up Homebrew | ||
uses: Homebrew/actions/setup-homebrew@master | ||
|
||
- name: Install UDS CLI | ||
shell: bash | ||
# renovate: datasource=github-tags depName=defenseunicorns/uds-cli versioning=semver | ||
run: brew install defenseunicorns/tap/[email protected] | ||
|
||
- name: "Login to GHCR" | ||
uses: docker/login-action@343f7c4344506bcbf9b4de18042ae17996df046d # v3.0.0 | ||
with: | ||
registry: ghcr.io | ||
username: dummy | ||
password: ${{ github.token }} | ||
|
||
- name: Build and Publish | ||
run: uds run build-and-publish |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
.cache/ | ||
.idea/ | ||
build/ | ||
.DS_Store | ||
*.tar.zst | ||
zarf-sbom | ||
tmp/ | ||
|
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
{ | ||
".": "0.0.0" | ||
} |
Empty file.
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
# Welcome to the [NAME] UDS Capability | ||
|
||
Thank you for your interest in this Defense Unicorns UDS Capability! | ||
|
||
This document describes the process and requirements for contributing to this UDS Capability. | ||
|
||
## Table of Contents | ||
|
||
1. [Developer Experience](#developer-experience) | ||
2. [Definition of Done](#definition-of-done) | ||
3. [Getting Started](#getting-started) | ||
4. [Submitting a Pull Request](#submitting-a-pull-request) | ||
5. [PR Requirements](#pr-requirements) | ||
6. [Contact](#contact) | ||
|
||
## Developer Experience | ||
|
||
Continuous Delivery is core to our development philosophy. Check out [https://minimumcd.org](https://minimumcd.org) for a good baseline agreement on what that means. | ||
|
||
Specifically: | ||
|
||
* We do trunk-based development (main) with short-lived feature branches that originate from the trunk, get merged into the trunk, and are deleted after the merge | ||
* We don't merge code into main that isn't releasable | ||
* We perform automated testing on all changes before they get merged to main | ||
* Continuous integration (CI) pipeline tests are definitive | ||
* We create immutable release artifacts | ||
|
||
## Definition of Done | ||
|
||
We apply these general principles to all User Stories and activities contributing to the UDS. | ||
|
||
* Automated continuous integration (CI) pipeline tests pass | ||
* CI pipeline tests have been updated to meet system changes | ||
* Changes are peer reviewed | ||
* Acceptance criteria is met | ||
* Documentation is updated to reflect what changed | ||
|
||
## Getting Started | ||
|
||
TBD | ||
|
||
## Submitting a Pull Request | ||
|
||
1. **Create an Issue**: For significant changes, please create an issue first, describing the problem or feature proposal. Trivial fixes do not require an issue. | ||
2. **Commit Your Changes**: Make your changes and commit them. All commits must be signed. | ||
3. **Run Tests**: Ensure that your changes pass all tests. | ||
4. **Push Your Branch**: Push your branch to your fork on GitHub. | ||
5. **Create a Pull Request**: Open a pull request against the `main` branch of the Capability repository. Please make sure that your PR passes all CI checks. | ||
|
||
### PR Requirements | ||
|
||
- PRs must be against the `main` branch. | ||
- PRs must pass CI checks. | ||
- All commits must be signed. | ||
- PRs should have a related issue, except for trivial fixes. | ||
|
||
## Contact | ||
|
||
For any questions or concerns, please open an issue on GitHub or contact the maintainers. |
Oops, something went wrong.