From f3fe554a4547b3d687f5f7e2758931bd50a7591e Mon Sep 17 00:00:00 2001 From: Zach Aller Date: Sun, 20 Oct 2024 17:16:44 -0500 Subject: [PATCH 1/6] change outline Signed-off-by: Zach Aller --- docs/concepts.md | 0 docs/index.md | 22 +++++++++---------- ...rchitecture.md => non-kubernetes-usage.md} | 0 mkdocs.yml | 3 +-- 4 files changed, 11 insertions(+), 14 deletions(-) delete mode 100644 docs/concepts.md rename docs/{architecture.md => non-kubernetes-usage.md} (100%) diff --git a/docs/concepts.md b/docs/concepts.md deleted file mode 100644 index e69de29..0000000 diff --git a/docs/index.md b/docs/index.md index 000ea34..a223ace 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,17 +1,15 @@ -# Welcome to MkDocs +# Welcome to GitOps Promotions -For full documentation visit [mkdocs.org](https://www.mkdocs.org). +GitOps Promoter is a tool designed to facilitate environment promotion in a GitOps workflow. It automates the process of promoting changes from one environment to the next by leveraging Git operations. The tool ensures that your environments are always in sync with the desired state defined in your Git repository. -## Commands +## Key Features -* `mkdocs new [dir-name]` - Create a new project. -* `mkdocs serve` - Start the live-reloading docs server. -* `mkdocs build` - Build the documentation site. -* `mkdocs -h` - Print help message and exit. +- **Automated Environment Promotion**: Seamlessly promote changes across environments. +- **GitOps First**: Adheres to GitOps principles, ensuring that all changes are version-controlled. +- **YAML Diff Detection**: Detects changes in YAML files to determine if a pull request is required. +- **Integration with CI/CD**: Easily integrates with your existing CI/CD pipelines. +- **ArgoCD Integration**: Supports ArgoCD for managing Kubernetes resources. -## Project layout +## Getting Started - mkdocs.yml # The configuration file. - docs/ - index.md # The documentation homepage. - ... # Other markdown pages, images and other files. +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 diff --git a/docs/architecture.md b/docs/non-kubernetes-usage.md similarity index 100% rename from docs/architecture.md rename to docs/non-kubernetes-usage.md diff --git a/mkdocs.yml b/mkdocs.yml index 5053824..1cab756 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -19,7 +19,6 @@ theme: nav: - Overview: index.md - Installation: installation.md - - Concepts: concepts.md - - Architecture: architecture.md - Getting Started: - Basic Usage: getting-started.md + - Non-Kubernetes Usage: non-kubernetes-usage.md From 4b75d1a69cef742e6cb3b45ffd9c415fb635c2f9 Mon Sep 17 00:00:00 2001 From: Zach Aller Date: Sun, 20 Oct 2024 17:22:09 -0500 Subject: [PATCH 2/6] 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 From 773317352910ac82d34ea887bef0dd9ce2782cc3 Mon Sep 17 00:00:00 2001 From: Zach Aller Date: Mon, 21 Oct 2024 10:10:45 -0700 Subject: [PATCH 3/6] save Signed-off-by: Zach Aller --- docs/index.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/docs/index.md b/docs/index.md index 4900bfc..30e53e5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,6 @@ # Welcome to GitOps Promotions -GitOps Promoter is a tool designed to facilitate environment promotion in a GitOps workflow. It automates the process of promoting changes from one environment to the next by leveraging Git operations. The tool ensures that your environments are always in sync with the desired state defined in your Git repository. +GitOps Promoter is a tool designed to facilitate environment promotion in a GitOps fashion. It automates the process of promoting changes from one environment to the next by leveraging Git operations. The tool can help ensures that your environments are always in sync with the desired state defined in your Git repository when used with a CD tool like ArogCD. ## Key Features @@ -8,10 +8,8 @@ GitOps Promoter is a tool designed to facilitate environment promotion in a GitO - **GitOps First**: Adheres to GitOps principles, ensuring that all changes are version-controlled. - **YAML Diff Detection**: Detects changes in YAML files to determine if a pull request is required. - **Integration with CI/CD**: Easily integrates with your existing CI/CD pipelines. -- **ArgoCD Integration**: Supports ArgoCD for managing Kubernetes resources. +- **ArgoCD Integration**: Supports ArgoCD when managing Kubernetes resources. -## Getting Started +## What is GitOps promotion. -To get started with GitOps Promoter, follow the [installation guide](installation.md) and the [basic usage instructions](getting-started.md). - -## Concepts of Promotion +GitOps promotion is the process of promoting changes across environments in a GitOps fashion. It involves using Git operations to manage the promotion of changes from one environment to the next. This ensures that all changes are version-controlled and that environments are always in sync with the desired state defined in your Git repository. From a5548b2bc01fd79ea4dd4247299b91e95268f886 Mon Sep 17 00:00:00 2001 From: Zach Aller Date: Sun, 20 Oct 2024 17:16:44 -0500 Subject: [PATCH 4/6] change outline Signed-off-by: Zach Aller --- docs/concepts.md | 0 docs/index.md | 22 +++++++++---------- ...rchitecture.md => non-kubernetes-usage.md} | 0 mkdocs.yml | 3 +-- 4 files changed, 11 insertions(+), 14 deletions(-) delete mode 100644 docs/concepts.md rename docs/{architecture.md => non-kubernetes-usage.md} (100%) diff --git a/docs/concepts.md b/docs/concepts.md deleted file mode 100644 index e69de29..0000000 diff --git a/docs/index.md b/docs/index.md index 000ea34..a223ace 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,17 +1,15 @@ -# Welcome to MkDocs +# Welcome to GitOps Promotions -For full documentation visit [mkdocs.org](https://www.mkdocs.org). +GitOps Promoter is a tool designed to facilitate environment promotion in a GitOps workflow. It automates the process of promoting changes from one environment to the next by leveraging Git operations. The tool ensures that your environments are always in sync with the desired state defined in your Git repository. -## Commands +## Key Features -* `mkdocs new [dir-name]` - Create a new project. -* `mkdocs serve` - Start the live-reloading docs server. -* `mkdocs build` - Build the documentation site. -* `mkdocs -h` - Print help message and exit. +- **Automated Environment Promotion**: Seamlessly promote changes across environments. +- **GitOps First**: Adheres to GitOps principles, ensuring that all changes are version-controlled. +- **YAML Diff Detection**: Detects changes in YAML files to determine if a pull request is required. +- **Integration with CI/CD**: Easily integrates with your existing CI/CD pipelines. +- **ArgoCD Integration**: Supports ArgoCD for managing Kubernetes resources. -## Project layout +## Getting Started - mkdocs.yml # The configuration file. - docs/ - index.md # The documentation homepage. - ... # Other markdown pages, images and other files. +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 diff --git a/docs/architecture.md b/docs/non-kubernetes-usage.md similarity index 100% rename from docs/architecture.md rename to docs/non-kubernetes-usage.md diff --git a/mkdocs.yml b/mkdocs.yml index 5053824..1cab756 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -19,7 +19,6 @@ theme: nav: - Overview: index.md - Installation: installation.md - - Concepts: concepts.md - - Architecture: architecture.md - Getting Started: - Basic Usage: getting-started.md + - Non-Kubernetes Usage: non-kubernetes-usage.md From 93070df2d424e8f0bfce80fe5f37e20878f22e65 Mon Sep 17 00:00:00 2001 From: Zach Aller Date: Sun, 20 Oct 2024 17:22:09 -0500 Subject: [PATCH 5/6] 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 2a51ec5..4975d88 100644 --- a/api/v1alpha1/commitstatus_types.go +++ b/api/v1alpha1/commitstatus_types.go @@ -31,14 +31,18 @@ type CommitStatusSpec struct { // +kubebuilder:validation:Required RepositoryReference NamespacedObjectReference `json:"gitRepositoryRef"` + // 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 From 6cc9aeb225e553523ef4bf2c3b63e41c4a4212df Mon Sep 17 00:00:00 2001 From: Zach Aller Date: Mon, 21 Oct 2024 10:10:45 -0700 Subject: [PATCH 6/6] save Signed-off-by: Zach Aller --- docs/index.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/docs/index.md b/docs/index.md index 4900bfc..30e53e5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,6 @@ # Welcome to GitOps Promotions -GitOps Promoter is a tool designed to facilitate environment promotion in a GitOps workflow. It automates the process of promoting changes from one environment to the next by leveraging Git operations. The tool ensures that your environments are always in sync with the desired state defined in your Git repository. +GitOps Promoter is a tool designed to facilitate environment promotion in a GitOps fashion. It automates the process of promoting changes from one environment to the next by leveraging Git operations. The tool can help ensures that your environments are always in sync with the desired state defined in your Git repository when used with a CD tool like ArogCD. ## Key Features @@ -8,10 +8,8 @@ GitOps Promoter is a tool designed to facilitate environment promotion in a GitO - **GitOps First**: Adheres to GitOps principles, ensuring that all changes are version-controlled. - **YAML Diff Detection**: Detects changes in YAML files to determine if a pull request is required. - **Integration with CI/CD**: Easily integrates with your existing CI/CD pipelines. -- **ArgoCD Integration**: Supports ArgoCD for managing Kubernetes resources. +- **ArgoCD Integration**: Supports ArgoCD when managing Kubernetes resources. -## Getting Started +## What is GitOps promotion. -To get started with GitOps Promoter, follow the [installation guide](installation.md) and the [basic usage instructions](getting-started.md). - -## Concepts of Promotion +GitOps promotion is the process of promoting changes across environments in a GitOps fashion. It involves using Git operations to manage the promotion of changes from one environment to the next. This ensures that all changes are version-controlled and that environments are always in sync with the desired state defined in your Git repository.