From 4b75d1a69cef742e6cb3b45ffd9c415fb635c2f9 Mon Sep 17 00:00:00 2001 From: Zach Aller Date: Sun, 20 Oct 2024 17:22:09 -0500 Subject: [PATCH] change outline Signed-off-by: Zach Aller --- api/v1alpha1/commitstatus_types.go | 5 +++++ docs/github-app-configuration.md | 0 docs/index.md | 4 +++- mkdocs.yml | 5 ++++- 4 files changed, 12 insertions(+), 2 deletions(-) create mode 100644 docs/github-app-configuration.md diff --git a/api/v1alpha1/commitstatus_types.go b/api/v1alpha1/commitstatus_types.go index 4a83878..e25cbe8 100644 --- a/api/v1alpha1/commitstatus_types.go +++ b/api/v1alpha1/commitstatus_types.go @@ -31,14 +31,18 @@ type CommitStatusSpec struct { // +kubebuilder:validation:Required RepositoryReference *Repository `json:"repository"` + // Sha is the commit sha to report the status for // +kubebuilder:validation:Required Sha string `json:"sha"` + // Name is the name of the status check // +kubebuilder:validation:Required Name string `json:"name"` + // Description is the description of the status check Description string `json:"description"` + // Phase is the state of the status check it can be one of pending, success, failure // +kubebuilder:validation:Required // +kubebuilder:default:=pending // +kubebuilder:validation:Enum:=pending;success;failure @@ -47,6 +51,7 @@ type CommitStatusSpec struct { // (Gitlab: pending, running, success, failed, canceled) // (Bitbucket: INPROGRESS, STOPPED, SUCCESSFUL, FAILED) + // Url is the url to the status check to provide more information Url string `json:"url"` } diff --git a/docs/github-app-configuration.md b/docs/github-app-configuration.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/index.md b/docs/index.md index a223ace..4900bfc 100644 --- a/docs/index.md +++ b/docs/index.md @@ -12,4 +12,6 @@ GitOps Promoter is a tool designed to facilitate environment promotion in a GitO ## Getting Started -To get started with GitOps Promoter, follow the [installation guide](installation.md) and the [basic usage instructions](getting-started.md). \ No newline at end of file +To get started with GitOps Promoter, follow the [installation guide](installation.md) and the [basic usage instructions](getting-started.md). + +## Concepts of Promotion diff --git a/mkdocs.yml b/mkdocs.yml index 1cab756..be89763 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -18,7 +18,10 @@ theme: name: Switch to light mode nav: - Overview: index.md - - Installation: installation.md + - Installation: + - Installation: installation.md + - Github Application Configuration: github-app-configuration.md - Getting Started: - Basic Usage: getting-started.md - Non-Kubernetes Usage: non-kubernetes-usage.md + - CRD Reference: crd-reference.md