From c426826d96607275fe6526971c8315b5d6c37cde Mon Sep 17 00:00:00 2001
From: awendt <anthony@defenseunicorns.com>
Date: Fri, 25 Aug 2023 14:59:20 -0600
Subject: [PATCH] Updates to get capability to alpha (#26)

* Add proper baseline docs

* Update CHANGELOG

* Add DEVELOPMENT_MAINTENANCE doc

* Update DEVELOPMENT_MAINTENANCE doc

* Cleanup
---
 CHANGELOG.md                    | 11 +++++++++++
 CODEOWNERS                      |  1 +
 CONTRIBUTING.md                 | 27 +++++++++++++++++++++++++++
 docs/DEVELOPMENT_MAINTENANCE.md | 30 ++++++++++++++++++++++++++++++
 4 files changed, 69 insertions(+)
 create mode 100644 CHANGELOG.md
 create mode 100644 CODEOWNERS
 create mode 100644 CONTRIBUTING.md
 create mode 100644 docs/DEVELOPMENT_MAINTENANCE.md

diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..4bb8231
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,11 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [0.0.0] - 2023-08-22
+PRE RELEASE
+
+### Added
+- Initial CHANGELOG.md
+- CONTRIBUTING.md
+- CODEOWNERS
diff --git a/CODEOWNERS b/CODEOWNERS
new file mode 100644
index 0000000..88b9f0f
--- /dev/null
+++ b/CODEOWNERS
@@ -0,0 +1 @@
+* @defenseunicorns/software-factory-package-core
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..1ff7931
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,27 @@
+# Welcome to the Gitlab 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.
+
+## 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 SWF.
+
+* 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
diff --git a/docs/DEVELOPMENT_MAINTENANCE.md b/docs/DEVELOPMENT_MAINTENANCE.md
new file mode 100644
index 0000000..8f7c668
--- /dev/null
+++ b/docs/DEVELOPMENT_MAINTENANCE.md
@@ -0,0 +1,30 @@
+# UDS Capability Gitlab
+
+## How to upgrade this capability
+
+This package is pulling in the [bigbang gitlab chart](https://repo1.dso.mil/big-bang/product/packages/gitlab)
+
+The [gitlab-flux-values.yaml](../gitlab-flux-values.yaml) file contains values used when creating the flux resources for this capability. This includes the version of the chart and the base values used for this capability.
+
+To upgrade
+1) Point `application.ref.tag` to the updated version of the chart.
+1) Update any base values if necessary.
+1) Update the `gitlab` component in the [zarf.yaml](../zarf.yaml) file to pull in the correct images needed for the updated version of the chart.
+
+## How to test this capability
+
+1) With docker running and while connected to an aws account.
+2) Set these env variables.
+```bash
+export REPO_URL=https://github.com/defenseunicorns/uds-capability-gitlab.git
+export GIT_BRANCH=<REPLACE_ME>
+export REGISTRY1_USERNAME=<REPLACE_ME>
+export REGISTRY1_PASSWORD=<REPLACE_ME>
+export GHCR_USERNAME=<REPLACE_ME>
+export GHCR_PASSWORD=<REPLACE_ME>
+export AWS_AVAILABILITY_ZONE=a
+```
+
+ 3) At the root of this repository, you can run `make test`. This will provision an ec2 instance, build and deploy all dependencies and packages, and run an e2e test to insure the capability is deploying successfully, available and ready.
+
+You can also follow the bread crumbs of the Makefile to manually create the cluster as well as build and deploy all the necessary packages.
\ No newline at end of file